Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

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 13 hours ago
JSON representation

Repository metadata

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

README.md

ORBIT

Offshore Renewables Balance of system and Installation Tool

PyPI version
PyPI downloads
Apache 2.0
image

Binder
Pre-commit
Black
isort
Ruff

Authors

Curent Maintainers

  • Rob Hammond

Documentation

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

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 incorporte, 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 localling, 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 dependences 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

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 752
Total Committers: 17
Avg Commits per committer: 44.235
Development Distribution Score (DDS): 0.621

Commits in past year: 18
Committers in past year: 4
Avg Commits per committer in past year: 4.5
Development Distribution Score (DDS) in past year: 0.5

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
mshields m****s@n****v 32
Rob r****d@n****v 31
Garrett Barter g****r@n****v 30
Rob Hammond 1****2 27
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:

Issue and Pull Request metadata

Last synced: 3 days ago

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

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
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

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

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: 6.546785410760524