Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FlascDataFrame for better handling of user data in FLASC #212

Merged
merged 8 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/deploy-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 4 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ parts:
- caption: User Reference
chapters:
# - file: data_processing
- file: flasc_data_format
- file: energy_ratio
- file: total_uplift
- file: licensing
Expand All @@ -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
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/energy_ratio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading
Loading