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: about 21 hours 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 (about 6 years ago)
• Default Branch: dev
• Last Pushed: 2026-01-09T19:18:29.000Z (about 1 month ago)
• Last Synced: 2026-01-30T19:55:07.243Z (12 days ago)
• Language: Python
• Homepage: https://nlrwindsystems.github.io/ORBIT/
• Size: 18 MB
• Stars: 22
• Watchers: 9
• Forks: 21
• Open Issues: 18
• Releases: 10
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

README.rst

          ORBIT
=====

Offshore Renewables Balance of system and Installation Tool

|PyPI version| |PyPI downloads| |Apache 2.0| |image|

|Binder| |Pre-commit| |Black| |isort| |Ruff|

:Authors: `Jake Nunemaker `_, `Matt Shields `_, `Rob Hammond `_, `Nick Riccobono `_
:Documentation: `ORBIT Docs `_

Installation
------------

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.

Environment
~~~~~~~~~~~

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 `_.

Instructions
~~~~~~~~~~~~

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.

    .. code-block:: console

        conda create -n  python=3.10 --no-default-packages

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

    .. code-block:: console

        conda activate 
        conda deactivate 

4. Clone the repository:
   ``git clone https://github.com/WISDEM/ORBIT.git``
5. Navigate to the top level of the repository
   (``/ORBIT/``) and install ORBIT as an editable package
   with following command.

    .. code-block:: console

       # 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]'

       # OR if you wish to use native plotting tools
       pip install -e '.[plot]'

6. (Development only) Install the pre-commit hooks to autoformat and lint code.

    .. code-block:: console

        pre-commit install

Dependencies
~~~~~~~~~~~~

- Python >=3.10, <=3.13
- marmot-agents
- SimPy
- NumPy
- Pandas
- SciPy
- OpenMDAO (>=3.2)
- python-benedict
- statsmodels
- PyYAML

Development Specific
~~~~~~~~~~~~~~~~~~~~

- pre-commit
- black
- isort
- ruff
- pytest
- pytest-cov
- sphinx
- sphinx-rtd-theme

Optional Plotting
~~~~~~~~~~~~~~~~~
- matplotlib

Recommended packages for easy iteration and running of code:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- jupyterlab


.. |PyPI version| image:: https://badge.fury.io/py/orbit-nrel.svg
   :target: https://badge.fury.io/py/orbit-nrel
.. |PyPI downloads| image:: https://img.shields.io/pypi/dm/orbit-nrel?link=https%3A%2F%2Fpypi.org%2Fproject%2Forbit-nrel%2F
   :target: https://pypi.org/project/orbit-nrel/
.. |Apache 2.0| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
   :target: https://opensource.org/licenses/Apache-2.0
.. |image| image:: https://img.shields.io/pypi/pyversions/orbit-nrel.svg
   :target: https://pypi.python.org/pypi/orbit-nrel
.. |Binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/WISDEM/ORBIT/dev?filepath=examples
.. |Pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
   :target: https://pycqa.github.io/isort/
.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff

        

---

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

Last Year

---

Committers metadata

Last synced: 3 days ago

Name	Email	Commits
Jake Nunemaker	j****r@g****m	285
nriccobo	N****o@n****v	163
jnunemak	j****r@n****v	48
Jake Nunemaker	J****r@n****v	41
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
Rob Hammond	1****2	21
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

---

Dependencies

Score: 6.522092798170153