frostytear / openmdao Goto Github PK

PLEASE NOTE: Until recently, this repository was named OpenMDAO/blue. If you had cloned that repository, please update your repository name and remotes to reflect these changes.

The OpenMDAO 1.7.3 codebase repo has been renamed to OpenMDAO1, and it resides at https://github.com/OpenMDAO/OpenMDAO1

The OpenMDAO 2.0.x code has taken the name OpenMDAO, and it resides at https://github.com/OpenMDAO/OpenMDAO.

Installation of 2.0.x code will now work with pip install openmdao. Installation of 1.7.3 code will now only work with a version specifier: pip install openmdao==1.7.3

To use the OpenMDAO v0.x legacy version (versions 0.13.0 and older) of the OpenMDAO-Framework, go here: https://github.com/OpenMDAO/OpenMDAO-Framework

This is an ALPHA version of OpenMDAO 2

Our latest docs are available at http://openmdao.org/twodocs/versions/latest Our archived 2 docs are available at http://openmdao.org/twodocs

While the API is MOSTLY stable, we reserve the right to change things as needed.

We will be making very frequent updates to this code. If you’re going to try it, make sure you pull these updates often.

Be aware that this is an Alpha. Not all the features of 1.7.x exist in 2.x yet.

Here is a list of things that have not yet been developed in 2.x:

• Pass-by-object variables
• automatic ordering of groups/components based on data connections
• DOE (Design of Experiment) driver and all other case drivers
• Parallel Finite Difference
• File variables
• Active-set constraint calculation disabling
• Brent Solver
• CaseRecording using CSV, HDF5, and dump recorders (SqliteRecorder and WebRecorder are currently supported)

Use git to clone the repository:

git clone http://github.com/OpenMDAO/OpenMDAO

Use pip to install openmdao locally:

cd OpenMDAO

pip install .

cd openmdao/docs

make all

This will build the docs into openmdao/docs/_build/html.

Then, just open openmdao/docs/_build/html/index.html in a browser to begin.