Offshore Renewables Balance of system and Installation Tool
|Authors:||Jake Nunemaker, Matt Shields, Rob Hammond|
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.
git --versionin the terminal. If an error occurs, install git using these directions.
From the terminal, install pip by running:
conda install -c anaconda pip
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>
Clone the repository:
git clone https://github.com/WISDEM/ORBIT.git
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]'
(Development only) Install the pre-commit hooks to autoformat code and check that tests pass.