Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
72065a0
adopt Jupyter Book framework, reorganize folders, and fix broken links
RHammond2 Mar 17, 2026
1d2f531
NREL -> NLR and WISDEM -> NLRWindSystems
RHammond2 Mar 17, 2026
231df89
fix linting errors
RHammond2 Mar 17, 2026
ec518b9
add pre-commit check for PRs
RHammond2 Mar 17, 2026
a8e7f13
remove outdated sidebar from docs homepage
RHammond2 Mar 17, 2026
de9225f
update pubs
RHammond2 Mar 18, 2026
f5fb2e8
make use of MD for design and install linkages
RHammond2 Mar 18, 2026
114386b
remove redundany API from titles
RHammond2 Mar 18, 2026
f89d8ce
convert managers to markdown and add parametric to overview
RHammond2 Mar 18, 2026
4e354e6
update manager methods docs to markdown
RHammond2 Mar 18, 2026
aef48a6
update refs and partially convert design methods docs to jb
RHammond2 Mar 19, 2026
9b2f0f8
finish reformatting design methods
RHammond2 Mar 19, 2026
f007c56
convert installation methods docs
RHammond2 Mar 19, 2026
d1781ee
convert team and common cost
RHammond2 Mar 19, 2026
b5e31bc
fix build issues
RHammond2 Mar 19, 2026
8e13ac5
convert changelog and examples directory to markdown and update forma…
RHammond2 Mar 19, 2026
833c63c
reorg getting started for simplicity
RHammond2 Mar 19, 2026
c3a670f
convert tutorial to md
RHammond2 Mar 19, 2026
14cd828
update source md
RHammond2 Mar 19, 2026
74ed9db
fix docstring and docs issues
RHammond2 Mar 19, 2026
cae038b
convert design tutorial to executable markdown
RHammond2 Mar 19, 2026
2b56078
tidy docstring
RHammond2 Mar 19, 2026
8992000
fix missing version and update changelog
RHammond2 Mar 19, 2026
b3f46d7
add design and install phase listing
RHammond2 Mar 24, 2026
a3066fe
fix changelog reference
RHammond2 Mar 24, 2026
f1ba869
add a new introduction tutorial to replace facets of other tutorials
RHammond2 Mar 24, 2026
3166465
add execution status table
RHammond2 Mar 24, 2026
0079f2a
Merge branch 'dev' into docs/upgrade-to-jb
RHammond2 Mar 25, 2026
d83e308
update changelog
RHammond2 Mar 25, 2026
434038f
simplify intro naming and final intro consolidation
RHammond2 Mar 25, 2026
a9baa8c
use double quotes
RHammond2 Mar 25, 2026
c70ba56
update project manager tutorial and remove replaced content
RHammond2 Mar 26, 2026
ecc3e79
add a library section and update project manager intros
RHammond2 Mar 26, 2026
61f6742
move landfall to new home
RHammond2 Mar 26, 2026
b66c380
start adding phase timing intro
RHammond2 Mar 26, 2026
b34893d
add starting dates to project manager
RHammond2 Mar 26, 2026
400a580
add vessel configuration details
RHammond2 Mar 26, 2026
96f7e32
fix docstring typos
RHammond2 Mar 26, 2026
309b749
update vessel specs
RHammond2 Mar 26, 2026
c5742dd
replace vessel guide with intro
RHammond2 Mar 26, 2026
801e756
fix docs build issues
RHammond2 Mar 26, 2026
30966f8
add docs build script for docs updating
RHammond2 Mar 26, 2026
e9356cd
restructure folders for simplicity and move changelog to repo-level file
RHammond2 Mar 26, 2026
6d5fa59
add binder badge and update descriptions for tutorials and examples
RHammond2 Mar 26, 2026
f441d19
update changelog reference in the toc
RHammond2 Mar 26, 2026
5bd1186
fix broken relative file references
RHammond2 Mar 31, 2026
a4fb949
start updating outputs
RHammond2 Mar 31, 2026
a30840a
fix build errors
RHammond2 Mar 31, 2026
c3667a7
finish adding capex values
RHammond2 Mar 31, 2026
39eabb6
convert the progress summary data types to standard Python
RHammond2 Mar 31, 2026
daceab0
finish updating the available outputs tutorial
RHammond2 Apr 1, 2026
2d785da
add examples copy of the completed tutorials
RHammond2 Apr 1, 2026
895595f
add weather to project manager and fix typo
RHammond2 Apr 1, 2026
e92a61d
convert to examples folder
RHammond2 Apr 1, 2026
46f4653
move examples to examples/index
RHammond2 Apr 1, 2026
f23c596
remove now obselete examples
RHammond2 Apr 1, 2026
61b2da7
fix issue in toc
RHammond2 Apr 1, 2026
b3ed050
revamp parametric manager and minor reformatting to project
RHammond2 Apr 1, 2026
540b6e0
remove now defunct parametric manager example
RHammond2 Apr 1, 2026
ebaafc9
rerun full docs build and update examples copies
RHammond2 Apr 1, 2026
7c73876
convert examples to topical guides
RHammond2 Apr 1, 2026
e57f2c6
pluralize tutorial
RHammond2 Apr 1, 2026
d935c87
examples -> topical guides
RHammond2 Apr 1, 2026
c8636db
add fixed reference point
RHammond2 Apr 1, 2026
9c916c3
update toc
RHammond2 Apr 1, 2026
0689dad
update custom array layout for docs through the end of overview
RHammond2 Apr 1, 2026
5a5fd5a
merge dev and fix conflicts
RHammond2 Apr 2, 2026
18d03e1
add up through case 2
RHammond2 Apr 2, 2026
e667baf
fix issue with printout not adjusting to user input.
RHammond2 Apr 2, 2026
eea9cfd
update changelog
RHammond2 Apr 2, 2026
4f7dee4
finish updating custom array layout example
RHammond2 Apr 3, 2026
48192eb
add the plant folder
RHammond2 Apr 3, 2026
04814d4
remove now defunct custom array layout notebook
RHammond2 Apr 6, 2026
cac9087
remove now defunct cash flow
RHammond2 Apr 6, 2026
6c5f3cb
remove generic fixed and floating examples
RHammond2 Apr 6, 2026
ae43395
add cable installation topical guide and remove extra file in custom …
RHammond2 Apr 6, 2026
3a2b603
fix book builder
RHammond2 Apr 6, 2026
5250e99
add updated guides to examples
RHammond2 Apr 6, 2026
7d662d8
fix typo in folder location
RHammond2 Apr 9, 2026
238a5a3
replace monopile gbf example with tutorial
RHammond2 Apr 9, 2026
4410c4f
update examples versions of tutorials and update configurations
RHammond2 Apr 9, 2026
f2d52a3
update TOC to include new pages
RHammond2 Apr 10, 2026
bdf6381
replace fixed substructure, supply chain, and export design examples
RHammond2 Apr 10, 2026
eb1a456
rerun examples
RHammond2 Apr 10, 2026
2e45537
run pre-commit across the project
RHammond2 Apr 10, 2026
a1c8c6e
rerun pre-commit
RHammond2 Apr 10, 2026
975bd36
fix pre-commit bug
RHammond2 Apr 10, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: pre-commit
on:
push:
branches: [main, dev]
pull_request:
branches: [main, dev]
jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"

- name: Run pre-commit
uses: pre-commit/[email protected]
362 changes: 362 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [2020] [National Renewable Energy Laboratory]
Copyright [2026] [National Laboratory of the Rockies]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
"Rob Hammond",
"Nick Riccobono",
]
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Nick Riccobono"
__email__ = ["nicholas.riccobono@nrel.gov", "rob.hammond@nrel.gov"]
__email__ = ["nicholas.riccobono@nlr.gov", "rob.hammond@nlr.gov"]
__status__ = "Development"


Expand Down
4 changes: 2 additions & 2 deletions ORBIT/config.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides the configuration loading and saving methods."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


from pathlib import Path
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Core functionality of ORBIT installation phases."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


from .port import Port, WetStorage
Expand Down
10 changes: 5 additions & 5 deletions ORBIT/core/components.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides the `Crane` class."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"

import simpy

Expand Down Expand Up @@ -88,12 +88,12 @@ def __init__(self, dp_specs):

def extract_dp_specs(self, dp_specs):
"""
Extracts and defines jacking system specifications.
Extracts and defines dynamic positioning system specifications.

Parameters
----------
jacksys_specs : dict
Dictionary containing jacking system specifications.
dp_specs : dict
Dictionary containing dynamic positioning system specifications.
"""

self.dp_class = dp_specs.get("class", 1)
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/defaults/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Default inputs used throughout ORBIT."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"

from pathlib import Path

Expand Down
28 changes: 14 additions & 14 deletions ORBIT/core/defaults/common_costs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ substation_design:
topside_fab_cost_rate: 14500 # USD/t
topside_design_cost: # USD
#oldHVAC: 4.5e6
HVAC: 193140000
HVDC-monopole: 529200000
HVDC-bipole: 856800000
HVAC: 193140000
HVDC-monopole: 529200000
HVDC-bipole: 856800000
shunt_cost_rate: 44163 # USD/MW
mpt_unit_cost: 2992926 # USD/mpt
shunt_unit_cost: 10428 # USD/cable
Expand All @@ -38,27 +38,27 @@ substation_design:
topside_assembly_factor: 0.075 # %
converter_cost: # USD
HVAC: 0
HVDC-monopole: 228600000
HVDC-bipole: 532800000
HVDC-monopole: 228600000
HVDC-bipole: 532800000
oss_substructure_cost_rate: 3785 # USD/t
oss_pile_cost_rate: 0 # USD/t

# Onshore substation component cost rates
onshore_substation_design:
onshore_converter_cost: # USD
HVAC: 0
HVDC-monopole: 163724546
HVDC-bipole: 364991025
HVAC: 0
HVDC-monopole: 163724546
HVDC-bipole: 364991025
shunt_unit_cost: 13557 # USD/cable
switchgear_cost: 9729618 # USD/cable
compensation_rate: # USD/cable
HVAC: 32640626
HVDC-monopole: 0
HVDC-bipole: 0
HVAC: 32640626
HVDC-monopole: 0
HVDC-bipole: 0
onshore_construction_rate: # USD
HVAC: 5214158
HVDC-monopole: 91039190
HVDC-bipole: 104283150
HVAC: 5214158
HVDC-monopole: 91039190
HVDC-bipole: 104283150

# Semisubmersible component cost rates
semisubmersible_design:
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/environment.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""ORBIT specific marmot.Environment."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


from bisect import bisect
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/exceptions.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Custom exceptions used throughout ORBIT."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


import os
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/library.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
"""

__author__ = "Rob Hammond"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Rob Hammond"
__email__ = "rob.hammond@nrel.gov"
__email__ = "rob.hammond@nlr.gov"


import os
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/logic/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides the simulation logic shared across several modules."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


from .vessel_logic import ( # shuttle_items_to_queue
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/logic/vessel_logic.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides common simulation logic related to vessels."""

__author__ = ["Jake Nunemaker", "Rob Hammond"]
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


from marmot import process
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/port.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides the `Port` class."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"


import simpy
Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/supply_chain.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Supply chain related infrastructure."""

__author__ = "Jake Nunemaker"
__copyright__ = "Copyright 2022, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2022, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"

from marmot import Agent, process

Expand Down
4 changes: 2 additions & 2 deletions ORBIT/core/vessel.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Provides the `Vessel` class."""

__author__ = ["Jake Nunemaker", "Rob Hammond"]
__copyright__ = "Copyright 2020, National Renewable Energy Laboratory"
__copyright__ = "Copyright 2026, National Laboratory of the Rockies"
__maintainer__ = "Jake Nunemaker"
__email__ = "jake.nunemaker@nrel.gov"
__email__ = "jake.nunemaker@nlr.gov"

from collections import Counter, namedtuple

Expand Down
Loading
Loading