NAWEA update, patch edge cases, and fix typos (#131)

* fix typos * fixes duplicated timestamp formulations in CSV reading * correctly amend valid timestamps * fix bug in travel reaching end of sim before actions can be cancelled * udpate with NAWEA links * fix many typos * rerun examples post-typo fixing and rerun nawea notebook * update changelog (w/ typo fixes) and bump version * fix issue with heading * fix typo * update pre-commit * rerun pre-commit with update settings
WISDEM · Nov 13, 2023 · f2b7296 · f2b7296
1 parent 6f5c63d
commit f2b7296
Show file tree

Hide file tree

Showing 46 changed files with 5,643 additions and 5,286 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,22 +9,22 @@ repos:
           stages: [commit]
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0
+  rev: 23.11.0
   hooks:
   - id: black
     name: black
     stages: [commit]
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: 'v1.1.1'  # Use the sha / tag you want to point at
+  rev: 'v1.7.0'  # Use the sha / tag you want to point at
   hooks:
   - id: mypy
     entry: mypy --install-types --non-interactive --config-file .mypy.ini
     exclude: (^docs/|^tests/)
     additional_dependencies: ["types-python-dateutil", "types-attrs", "types-PyYAML"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.5.0
   hooks:
   -   id: trailing-whitespace
   -   id: end-of-file-fixer
@@ -40,7 +40,7 @@ repos:
 
 
 - repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.255
+  rev: v0.1.5
   hooks:
   - id: ruff
     args: [--fix]

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/jupyter_execute/examples/how_to.ipynb b/docs/jupyter_execute/examples/how_to.ipynb
diff --git a/docs/jupyter_execute/examples/metrics_demonstration.ipynb b/docs/jupyter_execute/examples/metrics_demonstration.ipynb
diff --git a/docs/jupyter_execute/examples/strategy_demonstration.ipynb b/docs/jupyter_execute/examples/strategy_demonstration.ipynb
diff --git a/docs/source/API/core.md b/docs/source/API/core.md
@@ -1,7 +1,7 @@
 # Simulation Core Classes
 
 There are a variety of components that enable a simulation to be run, from the
-environmen to the management of repairs to the servicing equipment. The below will show
+environment to the management of repairs to the servicing equipment. The below will show
 how each of the APIs are powered to enable the full flexibility of modeling.
 
 ```{image} ../images/simulation_tools.svg
@@ -11,13 +11,15 @@ how each of the APIs are powered to enable the full flexibility of modeling.
 ```
 
 ## Environment
+
 ```{eval-rst}
 .. autoclass:: wombat.core.environment.WombatEnvironment
    :members:
    :undoc-members:
 ```
 
 ## Repair Management
+
 ```{eval-rst}
 .. autoclass:: wombat.core.repair_management.RepairManager
    :members:
@@ -26,6 +28,7 @@ how each of the APIs are powered to enable the full flexibility of modeling.
 ```
 
 ## Servicing Equipment
+
 ```{eval-rst}
 .. automodule:: wombat.core.service_equipment
    :members:
@@ -40,6 +43,7 @@ how each of the APIs are powered to enable the full flexibility of modeling.
 ```
 
 ## Port
+
 ```{eval-rst}
 .. automodule:: wombat.core.port
    :exclude-members: Port

diff --git a/docs/source/API/index.md b/docs/source/API/index.md
@@ -3,7 +3,7 @@
 The WOMBAT framework relies on a set of base data classes powered by the attrs
 library and a series of simulation classes and methods to perform all the operations.
 
-To make a it easier for users, there is also a simulation interface provided.
+To make it easier for users, there is also a simulation interface provided.
 
 ## Package Hierarchy
 

diff --git a/docs/source/API/simulation_api.md b/docs/source/API/simulation_api.md
@@ -7,6 +7,7 @@
 ```
 
 ## Configuration
+
 ```{eval-rst}
 .. autoclass:: wombat.core.simulation_api.Configuration
    :members:
@@ -18,6 +19,7 @@
 ```
 
 ## Simulation Interface
+
 ```{eval-rst}
 .. autoclass:: wombat.core.simulation_api.Simulation
    :members:
@@ -27,9 +29,11 @@
     random_generator
 ```
 
-
 ## Metrics Computation
-For example usage of the Metrics class and its associated methods, please see the [examples documentation page](../examples/metrics_demonstration)
+
+For example usage of the Metrics class and its associated methods, please see the
+[examples documentation page](../examples/metrics_demonstration)
+
 ```{eval-rst}
 .. autoclass:: wombat.core.post_processor.Metrics
    :members: from_simulation_outputs, power_production, time_based_availability,

diff --git a/docs/source/API/types.md b/docs/source/API/types.md
@@ -10,7 +10,7 @@ simulation.
 :width: 2400px
 ```
 
-## What is this FromDictMixin I keep seeing in the code diagrams?
+## What is this `FromDictMixin` I keep seeing in the code diagrams?
 
 The `FromDictMixin` class provides a standard method for providing dictionary definitions
 to `attrs` dataclasses without worrying about overloading the definition. Plus, you get
@@ -27,6 +27,7 @@ hoping for the best.
 ## Scheduled and Unscheduled Maintenance
 
 ### Maintenance Tasks
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.Maintenance
    :members:
@@ -36,6 +37,7 @@ hoping for the best.
 ```
 
 ### Failures
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.Failure
    :members:
@@ -46,6 +48,7 @@ hoping for the best.
 ```
 
 ### Repair Requests
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.RepairRequest
    :members:
@@ -57,6 +60,7 @@ hoping for the best.
 ## Servicing Equipment and Crews
 
 ### Service Equipment
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.ServiceEquipmentData
    :members:
@@ -65,6 +69,7 @@ hoping for the best.
 ```
 
 ### ServiceCrew
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.ServiceCrew
    :members:
@@ -73,6 +78,7 @@ hoping for the best.
 ```
 
 ### Scheduled Service Equipment
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.ScheduledServiceEquipmentData
    :members:
@@ -88,6 +94,7 @@ hoping for the best.
 ```
 
 ### Unscheduled Service Equipment
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.UnscheduledServiceEquipmentData
    :members:
@@ -104,6 +111,7 @@ hoping for the best.
 ```
 
 ### Port Configuration
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.PortConfig
    :members:
@@ -117,6 +125,7 @@ hoping for the best.
 ## Wind Farm Support
 
 ### Subassembly Model
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.SubassemblyData
    :members:
@@ -127,6 +136,7 @@ hoping for the best.
 ```
 
 ### Wind Farm Map
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.WindFarmMap
    :members:
@@ -135,6 +145,7 @@ hoping for the best.
 ```
 
 ### Substation Map
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.SubstationMap
    :members:
@@ -143,6 +154,7 @@ hoping for the best.
 ```
 
 ### String
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.String
    :members:
@@ -151,6 +163,7 @@ hoping for the best.
 ```
 
 ### Sub String
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.SubString
    :members:
@@ -161,6 +174,7 @@ hoping for the best.
 ## Miscellaneous
 
 ### Fixed Cost Model
+
 ```{eval-rst}
 .. autoclass:: wombat.core.data_classes.FixedCosts
    :members:

diff --git a/docs/source/API/windfarm.md b/docs/source/API/windfarm.md
@@ -4,28 +4,32 @@ The wind farm classes define how the wind farm's graph model are created, and po
 timing out of the failures and maintenance events within the simulation for the cables,
 substations, and turbines.
 
-## Windfarm
+## Wind Farm
+
 ```{eval-rst}
 .. automodule:: wombat.windfarm.windfarm
    :members:
    :undoc-members:
 ```
 
 ## System: Wind turbine or substation
+
 ```{eval-rst}
 .. automodule:: wombat.windfarm.system.system
    :members:
    :undoc-members:
 ```
 
-## Subassembly: The modeled componenents of a system
+## Subassembly: The modeled components of a system
+
 ```{eval-rst}
 .. automodule:: wombat.windfarm.system.subassembly
    :members:
    :undoc-members:
 ```
 
 ## Cable: Hybrid system and subassembly model
+
 ```{eval-rst}
 .. automodule:: wombat.windfarm.system.cable
    :members:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -98,6 +98,7 @@
 nb_execution_mode = "auto"
 nb_execution_timeout = -1
 nb_execution_allow_errors = True
+nb_merge_streams = True
 # nb_execution_excludepatterns.extend(
 #     [
 #         "how_to.md",

diff --git a/docs/source/examples/examples_reference.md b/docs/source/examples/examples_reference.md
@@ -1,5 +1,4 @@
-Examples Reference
-==================
+# Examples Reference
 
 This page will provide a brief overview of the varying examples available in the
 [examples folder on GitHub](https://github.com/WISDEM/WOMBAT/blob/main/examples).
@@ -17,8 +16,8 @@ to users.
 
 ### `how_to.ipynb`
 
-This is a Jupyter Notebook version of the [*How To* section](./how_to.md) of the documentation that
-allows users to interact with the walk through.
+This is a Jupyter Notebook version of the [*How To* section](./how_to.md) of the
+documentation that allows users to interact with the walk through.
 
 ### `strategy_demonstration.ipynb`
 
@@ -37,7 +36,6 @@ allows users to interact with the varying maintenance strategy models.
 This is the notebook used for the NAWEA WindTech 2023 Workshop. See
 [here](../workshops/nawea_wind_tech_2023.md) for details.
 
-
 ## Validation
 
 ### `dinwoodie_validation.ipynb`