Offshore Renewables Balance of system and Installation Tool
| Version: | 1.0.8 |
|---|---|
| Authors: | Jake Nunemaker, Matt Shields, Rob Hammond |
| Documentation: | ORBIT Docs |
As of version 0.5.2, ORBIT is now pip installable with pip install orbit-nrel.
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 --versionin 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.
Download the latest version of Miniconda for the appropriate OS. Follow the remaining steps for the appropriate OS version.
From the terminal, install pip by running:
conda install -c anaconda pipNext, create a new environment for the project with the following.
conda create -n <environment_name> python=3.7 --no-default-packagesTo activate/deactivate the environment, use the following commands.
conda activate <environment_name> conda deactivate <environment_name>
Clone the repository:
git clone https://github.com/WISDEM/ORBIT.gitNavigate 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]'
(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)
- black
- isort
- pre-commit
- pytest
- sphinx
- sphinx-rtd-theme
- jupyterlab
- pandas