Merge branch 'main' into develop

NREL · Nov 14, 2023 · 385014d · 385014d
2 parents 5ddd708 + 2cd61cb
commit 385014d
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 329 deletions.
diff --git a/.github/workflows/continuous-integration-workflow.yaml b/.github/workflows/continuous-integration-workflow.yaml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
         os: [ubuntu-latest]
 
     steps:

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -13,5 +13,5 @@ parts:
   - caption: User Referece
     chapters:
     - file: data_processing
-    - file: data_analysis
+    - file: energy_ratio
     - file: licensing
diff --git a/docs/data_analysis.rst b/docs/data_analysis.rst
diff --git a/docs/energy_ratio.md b/docs/energy_ratio.md
@@ -0,0 +1,33 @@
+---
+output:
+  md_document:
+    variant: markdown_github
+bibliography: references.bib
+---
+
+
+# Energy ratio analysis
+
+The energy ratio metric is defined as the energy yield of a test turbine
+relative to the energy yield of one or multiple reference turbines for
+a particular wind rose, e.g., for annual operation. See
+[@Doekemeijer2022a] and [@Bay2022a] for a practical
+example of how the energy ratios can be used in the analyses of
+historical SCADA data of three offshore wind farms and their comparison
+to an engineering wind farm model.
+
+# Examples demonstrating energy ratio usage
+
+Starting in FLASC v1.4, the energy ratio calculation was reconfigured around a [polars](https://www.pola.rs/) back-end and new examples were put in place to demonstrate usage.
+
+Key syntax for computing energy ratios is provided in the examples:
+
+ - [Energy Ratio Syntax](../examples_artificial_data/03_energy_ratio/00_demo_energy_ratio_syntax.ipynb)
+ - [Energy Ratio Options](../examples_artificial_data/03_energy_ratio/01_demo_energy_ratio_options.ipynb)
+
+ With the remaining examples in examples_artificial_data/03_energy_ratio providing more detail on specific use cases.
+
+ Within the set of analysis of the smarteole dataset are also exmaples of using flasc's energy ratio calculations.  See for example:
+
+ - [Baseline Energy Ratio Analysis](../examples_smarteole/05_baseline_energy_ratio_analysis.ipynb)
+ - [Wake Steering Energy Ratio Analysis](../examples_smarteole/06_wake_steering_energy_ratio_analysis.ipynb)
diff --git a/examples_smarteole/0X_test_script.py b/examples_smarteole/0X_test_script.py
diff --git a/setup.py b/setup.py
@@ -27,7 +27,7 @@
     'streamlit',
     'tkcalendar',
     'seaborn',
-    'polars>=0.19.0'
+    'polars==0.19.5'
 ]
 
 EXTRAS = {