Add FlascDataFrame for better handling of user data in FLASC

.github/workflows/deploy-pages.yaml

@@ -25,6 +25,14 @@ jobs:
       run: |
         pip install -e ".[docs]"
 
+    # Make a copy of the examples folder within the docs folder
+    - name: Copy examples to docs
+      working-directory: ${{runner.workspace}}/flasc/
+      run: |
+        rsync -av --mkpath  examples_artificial_data/03_energy_ratio/ docs/examples/03_energy_ratio
+        rsync -av --mkpath  examples_artificial_data/floris_input_artificial/ docs/examples/floris_input_artificial
+        ls docs/examples
+
     # Build the book
     - name: Build the book
       working-directory: ${{runner.workspace}}/flasc/docs/

.gitignore

@@ -22,11 +22,14 @@ _autosummary
 *.p
 *.csv
 *.ftr
+*.pkl
 *.png
+.venv
 
 # Documentation build files
 docs/build
 SMARTEOLE_WakeSteering_ReadMe.xlsx
 SMARTEOLE_WakeSteering_Map.pdf
 SMARTEOLE-WFC-open-dataset.zip
 examples_artificial_data/03_energy_ratio/heterogeneity_layouts.pdf
+docs/examples

docs/_config.yml

@@ -42,10 +42,11 @@ sphinx:
   - 'sphinx.ext.autodoc'
   - 'sphinx.ext.autosummary'
   - 'sphinx.ext.viewcode'
-  - 'sphinx_autodoc_typehints'
+ # - 'sphinx_autodoc_typehints'
   - 'sphinxcontrib.autoyaml'
   - 'sphinx.ext.napoleon'       # Formats google and numpy docstring styles
   - 'sphinxcontrib.mermaid'
+ #- 'numpydoc'
   config:
     html_theme: sphinx_book_theme
     templates_path:
@@ -62,11 +63,12 @@ sphinx:
       member-order: bysource
       undoc-members: true
       private-members: true
+      inherited-members: false
       # special-members: true
       # inherited-members
       # show-inheritance
       # ignore-module-all
-      # imported-members: true
+      # imported-members: false
       # exclude-members
       # class-doc-from
       # no-value

docs/_toc.yml

@@ -13,6 +13,7 @@ parts:
   - caption: User Reference
     chapters:
     # - file: data_processing
+    - file: flasc_data_format
     - file: energy_ratio
     - file: total_uplift
     - file: licensing
@@ -23,6 +24,12 @@ parts:
   #   - file: development
   #   - file: testing
 
+  - caption: Examples
+    chapters:
+    # - file: flascdataframe
+    - file: examples/03_energy_ratio/00_demo_energy_ratio_syntax
+    - file: examples/03_energy_ratio/01_demo_energy_ratio_options
+
   - caption: API Reference
     chapters:
     - file: api

docs/api.rst

@@ -3,17 +3,17 @@ API Documentation
 
 FLASC is divided into a number of submodules, each of which is documented in detail below. The main submodules are:
 
+* `flasc.flasc_dataframe`: The FlascDataFrame
 * `flasc.analysis`: Contains functions for energy ratio analysis
 * `flasc.data_processing`: Contains functions for processing raw data
-* `flasc.model_fitting`: Contains functions for fitting FLORIS models to data
 * `flasc.utilities`: Contains utility functions for general use
 
 .. autosummary::
    :toctree: _autosummary
    :template: custom-module-template.rst
    :recursive:
 
+    flasc.flasc_dataframe
     flasc.analysis
-    flasc.model_fitting
     flasc.data_processing
     flasc.utilities

docs/energy_ratio.md

@@ -14,12 +14,12 @@ Starting in FLASC v1.4, the energy ratio calculation was reconfigured around a [
 
 Key syntax for computing energy ratios is provided in the examples:
 
- - [Energy Ratio Syntax](https://github.com/NREL/flasc/blob/main/examples_artificial_data/03_energy_ratio/00_demo_energy_ratio_syntax.ipynb)
- - [Energy Ratio Options](https://github.com/NREL/flasc/blob/main/examples_artificial_data/03_energy_ratio/01_demo_energy_ratio_options.ipynb)
+ - [Energy Ratio Syntax](examples/03_energy_ratio/00_demo_energy_ratio_syntax)
+ - [Energy Ratio Options](examples/03_energy_ratio/01_demo_energy_ratio_options)
 
  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:
+ Within the set of analysis of the smarteole dataset are also examples of using flasc's energy ratio calculations.  See for example:
 
  - [Baseline Energy Ratio Analysis](https://github.com/NREL/flasc/blob/main/examples_smarteole/05_baseline_energy_ratio_analysis.ipynb)
  - [Wake Steering Energy Ratio Analysis](https://github.com/NREL/flasc/blob/main/examples_smarteole/06_wake_steering_energy_ratio_analysis.ipynb)