Developer Documentation
1.0.0

Contents:

  • NWChemEx Community
  • Design Documentation
  • Documenting NWChemEx
  • NWChemEx Organization Conventions
  • Developing NWChemEx
    • Preliminaries
    • Developing C++ Software
    • Developing Python Software
    • Using IDEs to Develop NWX
      • VSCode
        • Setting Up VSCode for Linux
        • Setting Up VSCode on MacOS
        • Building NWX with VSCode
        • Developing NWX with VSCode
        • Developing in a Docker Container With VSCode
        • Tips and Tricks for VSCode
        • FAQs
  • Testing NWChemEx
  • Continuous Deployment
  • Additional Developer Resources
  • References
Developer Documentation
  • Developing NWChemEx
  • Using IDEs to Develop NWX
  • VSCode
  • Edit on GitHub

VSCode

Visual Studio Code, or VSCode, is an IDE from Microsoft. Despite being from Microsoft, VSCode is free, has a Linux version, and is suprisingly light weight for C++ development.

Contents:

  • Setting Up VSCode for Linux
    • Adding Extensions
    • Creating a Workspace
  • Setting Up VSCode on MacOS
    • Obtaining VSCode
    • Setup From Fresh Install
    • Creating an NWChemEx Development Environment
  • Building NWX with VSCode
    • Configuring the Build
    • Configuring the Project (i.e., running CMake)
    • Building the Project
    • Testing the Project
    • Building Sphinx Documentation
  • Developing NWX with VSCode
    • Version Control
    • Code Formatting
    • Documentation
    • Debugging
    • Profiling
  • Developing in a Docker Container With VSCode
    • Why?
    • Scenario 1: VSCode Creates a Docker Container and Runs In It
    • Sources
  • Tips and Tricks for VSCode
  • FAQs
    • How do I change the editor font size?
    • How do I get a ruler to signify the 80 character limit?
    • How do I get the reST extension to use a virtual environment?
    • How do I get the debugger to set breakpoints per file and not per filename?
    • How do I get the debugger to break on a throw?
Previous Next

© Copyright 2020, NWChemEx Team.

Built with Sphinx using a theme provided by Read the Docs.