Skip to main content

ORBIT

Offshore Renewables Balance of system and Installation Tool

PyPI version PyPI downloads Apache 2.0 image DOI 10.5281/zenodo.23547748 DOI:10.2172/1660132

Binder Pre-commit Black isort Ruff

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.

  1. Download the latest version of Miniconda.

  2. 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
    
  3. Activate the environment.

    conda activate orbit
    

    To deactivate an environment, simply use conda deactivate.

  4. 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.

  1. Open a terminal/Anaconda Prompt session and navigate to your desired folder location

    cd /path/to/desired/folder
    
  2. 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
    
  3. Enter the repository.

    cd ORBIT
    
  4. 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.

  1. Open a terminal/Anaconda Prompt session and navigate to your desired folder location

    cd /path/to/desired/folder
    
  2. 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.

  3. 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
    
  4. Enter the repository.

    cd ORBIT
    
  5. 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
  6. 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
    

Metadata

Release files for orbit-nrel 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orbit-nrel 1.3.1
File Size Uploaded Provenance Actions
orbit_nrel-1.3.1.tar.gz 6.5 MB With provenance Details for orbit_nrel-1.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for orbit-nrel 1.3.1
File Interpreter ABI Platform Actions
orbit_nrel-1.3.1-py3-none-any.whl Python 3 none any Details for orbit_nrel-1.3.1-py3-none-any.whl

Total release size: 6.7 MB

Release files / orbit_nrel-1.3.1.tar.gz

Download URL orbit_nrel-1.3.1.tar.gz
Size 6.5 MB
Tags Source
SHA-256 checksum
How to use checksums
c94a707fd936821b517afb5b69346c3bb232bf26e241321e255df6257167f317
BLAKE2b-256 checksum
How to use checksums
6f6d96e9e3111bbf909d3c8017ea34ba5826b51329751651e35fc5651c7a6ab2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Release files / orbit_nrel-1.3.1-py3-none-any.whl

Download URL orbit_nrel-1.3.1-py3-none-any.whl
Size 180.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
721d4654e6d728ba99f472f1835e4339ccaf708755b173250c8ac7bbc4b08ce4
BLAKE2b-256 checksum
How to use checksums
1ee109aa6b404fdb1a3fbe84ced35fb00430c3baae9f3717a8e7b4c02b819652
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Security for orbit-nrel 1.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for orbit_nrel-1.3.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page