Getting Started

The documentation for IDAES is built using Sphinx. To generate the HTML version of the documentation, first make sure Sphinx is installed for your version of Python, then go to the "docs/" subdirectory and run the Makefile:

cd docs
make html

To view the documentation you just built, open the file
docs/build/index.html in a web browser.

Running tests

After you install, you can run tests to make sure everything is working. We use pytest for testing and generating code coverage reports. The pytest command should be available in the conda environment created by running the install.sh script as described in the installation instructions.

To run tests against the core modules and DMF (not idaes/contrib), and generate a coverage report:

If there are errors, or you are having trouble, you can use our issue tracker on Github to look for other users experiencing similar problems, or to report a new bug.

Running a notebook

There are example Jupyter notebook(s) in the examples/ directory. To run them, you should invoke Jupyter on a Notebook file (these end in the extension .ipynb).

jupyter notebook examples/run-mea-model.ipynb

This should start up a notebook server and then pop up a tab or window in your default web browser showing the Notebook. For more information on how to use Jupyter, see the "Help" menu in the Notebook window itself, and the extensive documentation on the Jupyter website.