ORBIT

Offshore Renewable Balance-of-system Installation Tool computes capital costs and activity times for offshore wind plant balance-of-system (everything besides the turbine) costs.
https://github.com/nlrwindsystems/orbit

Category: Renewable Energy
Sub Category: Wind Energy

Keywords from Contributors

wind-energy wind wind-turbines operations-maintenance simpy openmdao systems-engineering wisdem cfd ecp

Last synced: 1 day ago
JSON representation

Repository metadata

Offshore Renewable Balance-of-system Installation Tool (ORBIT)

Host: GitHub
URL: https://github.com/nlrwindsystems/orbit
Owner: NLRWindSystems
License: apache-2.0
Created: 2019-12-09T19:05:10.000Z (over 6 years ago)
Default Branch: dev
Last Pushed: 2026-05-07T21:43:02.000Z (about 2 months ago)
Last Synced: 2026-06-16T02:04:49.533Z (7 days ago)
Language: Python
Homepage: https://nlrwindsystems.github.io/ORBIT/
Size: 20.8 MB
Stars: 23
Watchers: 9
Forks: 20
Open Issues: 18
Releases: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.bib

README.md

ORBIT

Offshore Renewables Balance of system and Installation Tool

Authors

Current Maintainers

Rob Hammond

Documentation

Please visit the documentation site at https://nlrwindsystems.github.io/ORBIT/

Citing ORBIT

Please cite this repository using the following citation, or with proceeding Bibtex.

Nunemaker, Jacob, Shields, Matthew, Hammond, Robert, et al.,
"ORBIT: Offshore Renewables Balance-of-System and Installation Tool," (2020),
https://doi.org/10.2172/1660132

@techreport{orbit_tech_report,
  author={Nunemaker, Jacob and Shields, Matthew and Hammond, Robert and Duffy, Patrick},
  title={ORBIT: Offshore Renewables Balance-of-System and Installation Tool},
  institution={National Renewable Energy Laboratory (NREL), Golden, CO (United States)},
  doi={10.2172/1660132},
  url={https://www.osti.gov/biblio/1660132},
  place={United States},
  year={2020},
  month={08}
}

Installation

pip install orbit-nrel

Environment Setup

It is highly recommended to use separate Python environments for all projects, as such we recommend
using Anaconda or Miniconda for a lightweight version of Anaconda. Please visit their
documentation for installation details. This guide will assume the use of Miniconda throughout.

Download the latest version of Miniconda.
Create a new environment. Below, we're using the name orbit for the environment, but
any name is allowed, just replace "orbit" with whichever name was used throughout the
installation instructions. Similarly, any compatible Python version is allowed even though we
specify 3.13 below.
```
conda create -n orbit python=3.13
```
Activate the environment.
```
conda activate orbit
```
To deactivate an environment, simply use conda deactivate.
Install ORBIT. See the pip installation directions above, or either of the source
or development sections below for further details.

Running Examples

For users wishing to run the examples provided as Jupyter Notebooks, please either install
the Jupyter Lab (preferred) or Jupyter Notebook library.

pip install jupyterlab

Source Installation

For users looking to modify ORBIT or build their own models to incorporate, installing
from the source code is required.

Open a terminal/Anaconda Prompt session and navigate to your desired folder location
```
cd /path/to/desired/folder
```
Clone the repository (or your fork). If cloning your own fork, replace "NLRWindSystems"
with your GitHub username.
```
git clone https://github.com/NLRWindSystems/ORBIT.git
```
Enter the repository.
```
cd ORBIT
```
Install ORBIT.
```
pip install .
```
For an editable installation that updates the installed version of ORBIT with any local changes,
use the -e flag.
```
pip install -e .
```

Development Setup

For more advanced users, such as those interested in building the documentation locally, running
tests, or even contributing code back to the library, please use the following instructions.

Open a terminal/Anaconda Prompt session and navigate to your desired folder location
```
cd /path/to/desired/folder
```
If you are going to contribute code back to the library, fork the repository as you will not
be able to push your code changes to the library otherwise.
Clone the repository (or your fork). If cloning your own fork, replace "NLRWindSystems"
with your GitHub username.
```
git clone https://github.com/NLRWindSystems/ORBIT.git
```
Enter the repository.
```
cd ORBIT
```
Install an editable version of ORBIT.
```
pip install -3 .
```
For developers install the developer dependencies in addition:
```
pip install -e .[dev,docs]
```
- dev: automated code linting and formatting tools, plus the testing suite.
- docs: documentation building tools
If contributing code back to the library, install the pre-commit hook to enable automated
formatting and linting. If this step is skipped, your PR will fail in the CI pipeline, and code
will not be reviewed until at least this step passes.
```
pre-commit install
```

Citation (CITATION.bib)

@techreport{orbit_tech_report,
  author={Nunemaker, Jacob and Shields, Matthew and Hammond, Robert and Duffy, Patrick},
  title={ORBIT: Offshore Renewables Balance-of-System and Installation Tool},
  institution={National Renewable Energy Laboratory (NREL), Golden, CO (United States)},
  doi={10.2172/1660132},
  url={https://www.osti.gov/biblio/1660132},
  place={United States},
  year={2020},
  month={08}
}

Owner metadata

Name: NLRWindSystems
Login: NLRWindSystems
Email: systems.engineering@nrel.gov
Kind: organization
Description: The home of wind energy systems models developed, released, and maintained by the National Laboratory of the Rockies, formerly named NREL
Website: https://www.nrel.gov/wind/systems-engineering.html
Location: United States of America
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/5444272?v=4
Repositories: 40
Last ynced at: 2026-01-15T00:49:55.882Z
Profile URL: https://github.com/NLRWindSystems

GitHub Events

Total

Delete event: 3
Pull request event: 6
Watch event: 1
Push event: 7
Create event: 2

Last Year

Delete event: 3
Pull request event: 6
Watch event: 1
Push event: 7
Create event: 2

Committers metadata

Last synced: 3 days ago

Total Commits: 760
Total Committers: 17
Avg Commits per committer: 44.706
Development Distribution Score (DDS): 0.625

Commits in past year: 26
Committers in past year: 4
Avg Commits per committer in past year: 6.5
Development Distribution Score (DDS) in past year: 0.346

Name	Email	Commits
Jake Nunemaker	j**r@g**m	285
nriccobo	N**o@n**v	164
jnunemak	j**r@n**v	48
Jake Nunemaker	J**r@n**v	41
Rob Hammond	1****2	35
mshields	m**s@n**v	32
Rob	r**d@n**v	31
Garrett Barter	g**r@n**v	30
Bredenkamp	s**k@n**v	25
Becca Rolph	r**h@n**v	14
Rafael M Mudafort	r**f@g**m	13
asharma	a**a@n**v	12
Sophie Bredenkamp	s**p@n**v	10
dmulash	1****h	9
pre-commit-ci[bot]	6****]	7
Mulas Hernando	d**h@n**v	3
John Jasa	j**1@g**m	1

Committer domains:

nrel.gov: 11

Issue and Pull Request metadata

Last synced: about 2 months ago

Total issues: 1
Total pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 19 minutes
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 2.0
Average comments per pull request: 0.0
Merged pull request: 1
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: 19 minutes
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 2.0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/nlrwindsystems/orbit

Top Issue Authors

shirubana (1)

Top Pull Request Authors

RHammond2 (1)

Top Issue Labels

documentation (1)

Top Pull Request Labels

bug (1)

Package metadata

Total packages: 1
Total downloads:
- pypi: 4,063 last-month
Total dependent packages: 2
Total dependent repositories: 3
Total versions: 20
Total maintainers: 3

pypi.org: orbit-nrel

Offshore Renewables Balance of system and Installation Tool

Homepage:
Documentation: https://orbit-nrel.readthedocs.io/
Licenses: Apache Software License
Latest release: 1.2.6 (published 3 months ago)
Last Synced: 2026-06-20T04:00:26.656Z (3 days ago)
Versions: 20
Dependent Packages: 2
Dependent Repositories: 3
Downloads: 4,063 Last month
Rankings:
- Dependent packages count: 3.144%
- Dependent repos count: 8.974%
- Average: 12.236%
- Downloads: 24.592%
Maintainers (3)

Dependencies

.github/workflows/gh_pages.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
peaceiris/actions-gh-pages v3.6.1 composite

.github/workflows/publish-to-pypi.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/tests.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/publish-to-test-pypi.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/pre-commit.yml actions

actions/checkout v6 composite
actions/setup-python v6 composite
pre-commit/action v3.0.1 composite

pyproject.toml pypi

Score: 14.858429359263503

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

ORBIT

Keywords from Contributors

Repository metadata

README.md

ORBIT

Authors

Current Maintainers

Documentation

Citing ORBIT

Installation

Environment Setup

Running Examples

Source Installation

Development Setup

Citation (CITATION.bib)

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: orbit-nrel

Dependencies