pgraf / commonse Goto Github PK

CommonSE is a collection of utilities for common use across the WISDEM set of tools.

Author: S. Andrew Ning, R. Damiani, and K. Dykes

This software is a beta version 0.1.1.

For detailed documentation see http://wisdem.github.io/CommonSE/

General: NumPy, SciPy, Swig, pyWin32, MatlPlotLib, Lxml, OpenMDAO

Wind Plant Framework: FUSED-Wind (Framework for Unified Systems Engineering and Design of Wind Plants)

Supporting python packages: Pandas, Algopy, Zope.interface, Sphinx, Xlrd, PyOpt, py2exe, Pyzmq, Sphinxcontrib-bibtex, Sphinxcontrib-zopeext, Numpydoc, Ipython

First, clone the repository or download the releases and uncompress/unpack (CommonSE.py-|release|.tar.gz or CommonSE.py-|release|.zip) from the website link at the bottom the CommonSE site.

Install CommonSE with the following command from within an activated OpenMDAO environment.

$ plugin install

To check if installation was successful you can try to import the module from within an activated OpenMDAO environment.

$ python
> import commonse.environment 

or run the unit tests

$ python src/commonse/test/test_environment_gradients.py

For software issues please use https://github.com/WISDEM/CommonSE/issues. For functionality and theory related questions and comments please use the NWTC forum for Systems Engineering Software Questions.