Release v1.3

.github/workflows/pre-commit.yml

@@ -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/action@v3.0.1

.gitignore

@@ -115,5 +115,10 @@ docs/cables/Figs
 # Pycharm
 .idea/
 
-# Other
+# ORBIT-specific
 Analysis/
+examples/configs/array_system.yaml
+examples/configs/export_system.yaml
+examples/configs/mooring_system.yaml
+examples/configs/oss.yaml
+examples/configs/substructure.yaml

CITATION.bib

@@ -0,0 +1,10 @@
+@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}
+}

LICENSE

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

ORBIT/__init__.py

@@ -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"
 
 
@@ -17,4 +17,4 @@
 from ORBIT.parametric import ParametricManager
 from ORBIT.supply_chain import SupplyChainManager
 
-__version__ = "1.2.6"
+__version__ = "1.3"

ORBIT/config.py

@@ -1,15 +1,17 @@
 """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
 
 import yaml
+import numpy as np
 from yaml import Dumper
+from benedict.dicts import benedict
 
 from ORBIT.core import loader
 
@@ -30,15 +32,49 @@ def load_config(filepath):
     return data
 
 
-def save_config(config, filepath, overwrite=False):
+def prepare_config_for_save(config: dict | benedict) -> dict:
+    """Prepare the configuration file for compatbility with the YAML
+    ``SafeDump`` class used for saving configurations to file.
+
+    Parameters
+    ----------
+    config : dict | benedict
+        ORBIT configuration dictionary.
+
+    Returns
+    -------
+    dict
+        ORBIT configuration dictionary where all NumPy data types are converted
+        to standard Python data types, e.g. ``np.float64`` -> ``float``.
     """
-    Save an ORBIT `config` to `filepath`.
+    for k, v in config.items():
+        match v:
+            case np.ndarray():
+                config[k] = v.tolist()
+            case np.floating():
+                config[k] = float(v)
+            case np.integer():
+                config[k] = int(v)
+            case benedict():
+                config[k] = prepare_config_for_save(v.dict())
+            case dict():
+                config[k] = prepare_config_for_save(v)
+            case _:
+                pass
+    return config
+
+
+def save_config(
+    config: dict | benedict, filepath: str | Path, overwrite: bool = False
+):
+    """
+    Save an ORBIT configuration to :py:attr:`filepath`.
 
     Parameters
     ----------
-    config : dict
+    config : dict | benedict
         ORBIT configuration.
-    filepath : str
+    filepath : str | Path
         Location to save config.
     overwrite : bool (optional)
         Overwrite file if it already exists. Default: False.
@@ -53,5 +89,9 @@ def save_config(config, filepath, overwrite=False):
         if filepath.exists():
             raise FileExistsError(f"File already exists at '{filepath}'.")
 
+    config = prepare_config_for_save(config)
+    if isinstance(config, benedict):
+        config = config.dict()
+
     with filepath.open("w") as f:
         yaml.dump(config, f, Dumper=Dumper, default_flow_style=False)

ORBIT/core/__init__.py

@@ -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

ORBIT/core/components.py

@@ -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
 
@@ -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)

ORBIT/core/defaults/__init__.py

@@ -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
 

ORBIT/core/defaults/common_costs.yaml

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

ORBIT/core/environment.py

@@ -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

ORBIT/core/exceptions.py

@@ -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

ORBIT/core/library.py

@@ -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

ORBIT/core/logic/__init__.py

@@ -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

ORBIT/core/logic/vessel_logic.py

@@ -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

ORBIT/core/port.py

@@ -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

ORBIT/core/supply_chain.py

@@ -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
 

ORBIT/core/vessel.py

@@ -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