enhancement: energy_loss update

.pre-commit-config.yaml

@@ -6,14 +6,14 @@ repos:
   hooks:
   - id: isort
     name: isort
-    stages: [commit]
+    stages: [pre-commit]
 
 - repo: https://github.com/psf/black
   rev: 23.11.0
   hooks:
   - id: black
     name: black
-    stages: [commit]
+    stages: [pre-commit]
 
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: 'v1.7.0'  # Use the sha / tag you want to point at

CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## Unreleased (TBD)
+
+- A series of bugs in the FLORIS time series method have been fixed to ensure energy potential
+  and production calculations add up as expected.
+- `loss_ratio` has been replaced with `environmental_loss_ratio` to account for the only loss
+  category that cannot be modeled in WAVES.
+- `turbine_type` input has been added to indicate if a project is land-based (coming soon), or
+  fixed or floating offshore wind
+- Energy losses are now available through:
+  - `Project._get_floris_energy()` to aggregate the FLORIS energy potential and waked energy
+    production to the correct level in place using the same methodology in multiple methods.
+  - `Project.energy_losses()` for calculating total energy losses across varying granularities
+  - `Project.loss_ratio()` with an ability to provide categorical breakdowns
+  - `Project.technical_loss_ratio()` to calculate the ORCA technical losses.
+  - `Project.electrical_loss_ratio()` to calculate the ORCA technical losses.
+- `Project.energy_potential()` now forms the basis of all energy production and loss methods to
+  ensure consistent computation.
+- A new series of validators have been added for commonly used parameterizations alongside a
+  decorator `@validate_common_inputs(which=...)` to apply the validations automatically before the
+  main methodology is run.
+
 ## 0.5.3 (7 May 2024)
 
 - A bug was fixed where the array system installation costs were nearly doubled when compared