Skip to main content

Offshore Renewables Balance of system and Installation Tool

Project description

Offshore Renewables Balance of system and Installation Tool




Jake Nunemaker, Matt Shields, Rob Hammond




As of version 0.5.2, ORBIT is now pip installable with pip install orbit-nrel.

Development Setup

The steps below are for more advanced users that would like to modify and and contribute to ORBIT.


A couple of notes before you get started:
  • It is assumed that you will be using the terminal on MacOS/Linux or the Anaconda Prompt on Windows. The instructions refer to both as the “terminal”, and unless otherwise noted the commands will be the same.

  • To verify git is installed, run git --version in the terminal. If an error occurs, install git using these directions.

  • The listed installation process is intended to be the easiest for any OS to get started. An alternative setup that doesn’t rely on Anaconda for setting up an environment can be followed here.


  1. Download the latest version of Miniconda for the appropriate OS. Follow the remaining steps for the appropriate OS version.

  2. From the terminal, install pip by running: conda install -c anaconda pip

  3. Next, create a new environment for the project with the following.

    conda create -n <environment_name> python=3.7 --no-default-packages

    To activate/deactivate the environment, use the following commands.

    conda activate <environment_name>
    conda deactivate <environment_name>
  4. Clone the repository: git clone

  5. Navigate to the top level of the repository (<path-to-ORBIT>/ORBIT/) and install ORBIT as an editable package with following command.

    # Note the "." at the end
    pip install -e .
    # OR if you are you going to be contributing to the code or building documentation
    pip install -e '.[dev]'
  6. (Development only) Install the pre-commit hooks to autoformat code and check that tests pass.

    pre-commit install


  • Python 3.7+

  • marmot-agents

  • NumPy

  • SciPy

  • Matplotlib

  • OpenMDAO (>=3.2)

Development Specific

  • black

  • isort

  • pre-commit

  • pytest

  • sphinx

  • sphinx-rtd-theme

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orbit-nrel-1.0.8.tar.gz (108.0 kB view hashes)

Uploaded Source

Built Distribution

orbit_nrel-1.0.8-py3-none-any.whl (144.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page