Developer Docs (if you’re going to contribute code)#
Developer Install#
Use git to clone the repository:
git clone http://github.com/OpenMDAO/OpenMDAO
Use pip to install openmdao locally:
cd OpenMDAO
pip install -e .
Note
The -e option tells pip to install directly from your repository. This is very useful when you’re developing because when you change the code or pull new commits down from GitHub, you don’t necessarily need to re-run the pip install.
Signing and Verifying GitHub Commits#
To ensure that they come from a trusted source, only pull requests that consist of verified commits can be merged to the OpenMDAO master branch.
Building the Docs#
You can read the docs online, so it is not necessary to build them locally on your machine. But if you’re going to build new features or add new examples, you’ll want to build the docs locally, so that you can check them while you are writing them.
Creating Your Own OpenMDAO Plugins#
Documentation Style Guide#
This document exists to help OpenMDAO documentation writers follow appropriate guidelines, in terms of formatting and embedding code.