diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 00000000..25a39344 --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,29 @@ +# Getting started + +The easiest way to get started is to install FLASC and +then follow the examples. The correct order is: + +## Install FLASC +Install the repository following the instructions `here `_. + +## FLASC examples +You can generate a demo dataset by following the examples in +``examples_smarteole/``. The notebook ``02_download_and_format_dataset.ipynb`` +downloads data from a wake steering experiment conducted in 2019. We encourage +users to step through the notebooks in ``examples_smarteole/`` in order to +develop an understanding of FLASC's capabilities using a dataset from a real +field experiment. + +Additional useful examples can be found in ``examples_artificial_data/``, where +we intentionally introduce "challenges" for the FLASC tools to solve using +artificially-generated data. This provides a good way for users to get to know +the FLASC tools in more depth. Again, we recommend stepping through the +examples in the subdirectories in their numerical order. + +Roughly speaking, the examples in both ``examples_smarteole/`` and +``examples_artificial_data`` demonstrate the FLASC modules in the order: +- `flasc.data_processing` +- `flasc.analysis` +- `flasc.model_fitting` + +and use `flasc.utilities` throughout. diff --git a/docs/getting_started.rst b/docs/getting_started.rst deleted file mode 100644 index 9e70ce08..00000000 --- a/docs/getting_started.rst +++ /dev/null @@ -1,56 +0,0 @@ -Getting started ---------------- - -The easiest way to get started is to install FLASC and -then follow the examples. The correct order is: - -Install FLASC -============= -Install the repository following the instructions `here `_. - -Generating an artificial dataset -================================ -You can generate a demo dataset using the script at -``examples_artificial_data/demo_dataset/``. The script ``generate_demo_dataset.py`` downloads -historical data from a meteorological measurement tower at the U.S. National -Wind Technology Center (NWTC), part of the National Renewable Energy -Laboratory (NREL). This data is made readily available to the public on its -corresponding `website `_. This script downloads -historical data for the entire year of 2019 at approximately 60 second -intervals. We then assume the wind direction measured by this met tower -is equal to the wind direction at every wind turbine in the wind farm. -Further, we derive each turbine's power production, wind speed and turbulence -intensity using the floris wind farm model. - -We then introduce realistic disturbances on these measurements. Firstly, we -add randomized noise. We also add curtailment periods to certain turbines, -in which the power production is saturated to a below-rated value for a -period of time. We also add other realistic noise on top of the turbine -wind-speed power curves. We then mark several weeks of the year for -a handful of turbines are completely faulty, mimicking turbine downtime, -for example for maintenance. We add northing errors to all of the turbines, -which is common in field data. We also mimic sensor-stuck type of faults, -in which certain sensors report the exact same measurement for unrealistically -long periods of time (e.g., a vane signal reporting 13.44 deg for 3 minutes -consecutively). Finally, we also add a measurement tower with wind direction, -wind speed and turbulence intensity measurements, and time-shift this data -by 2 hours. This represents the realistic situation in which external -measurement equipment and the turbine's internal logger follow a different -clock or timezone. - -Raw data processing -=================== -Once the artificial dataset has been generated, it should be filtered and -postprocessed using the steps described in -`Raw data processing `_. This will filter the SCADA data -for measurement outliers and deal with northing calibration. - - -Data-based analysis -=================== -Once the artificial dataset has been postprocessed, one can start performing -analyses. See `Data analysis `_ for examples on how to -derive useful information from the data, such as for model tuning and model -validation. - -.. seealso:: `Return to table of contents `_ diff --git a/docs/overview.md b/docs/overview.md index 27552fdf..757c8e68 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -2,97 +2,66 @@ FLASC provides a rich suite of analysis tools for SCADA data filtering & analysis, wind farm model validation, field experiment design, and field -experiment monitoring. The repository is centrally built around NRELs -in-house [floris](https://github.com/nrel/floris) wake modeling utility. -FLASC also largely relies on the energy ratio to, among others, quantify wake -losses in synthetic and historical data, to perform turbine northing +experiment monitoring. The repository is centrally built around NREL's +in-house [FLORIS](https://github.com/nrel/floris) wake modeling utility. +FLASC also largely relies on the "energy ratio" to quantify wake +losses in synthetic and historical data, perform turbine northing calibrations, and for model parameter estimation. -# Literature - -See a particular wind rose, e.g., for annual operation. See -{cite:p}`Doekemeijer2022a` and {cite:p}`Bay2022a`for a practical -example of how the flasc repository is used or processing and analyses of -historical SCADA data of three offshore wind farms. - - ```{bibliography} - ``` - -# Citation - - -If FLASC played a role in your research, please cite it. This software can be -cited as: - - FLASC. Version 2.0 (2024). Available at https://github.com/NREL/flasc. - -For LaTeX users: - - - @misc{flasc2024, - author = {NREL}, - title = {FLASC. Version 2.0}, - year = {2022}, - publisher = {GitHub}, - journal = {GitHub repository}, - url = {https://github.com/NREL/flasc}, - } +# FLASC package +FLASC consists of multiple modules, including: -# Questions -For technical questions regarding FLASC usage, please post your questions to -[GitHub Discussions](https://github.com/NREL/flasc/discussions) on the -FLASC repository. Alternatively, email the NREL FLASC team at -`paul.fleming@nrel.gov `_ or -`michael.sinner@nrel.gov `_. +## flasc.data_processing - + @misc{flasc2024, + author = {NREL}, + title = {FLASC. Version 2.0}, + year = {2022}, + publisher = {GitHub}, + journal = {GitHub repository}, + url = {https://github.com/NREL/flasc}, + } + + +# Questions + +For technical questions regarding FLASC usage, please post your questions to +[GitHub Discussions](https://github.com/NREL/flasc/discussions) on the +FLASC repository. Alternatively, email the NREL FLASC team at +`paul.fleming@nrel.gov `_ or +`michael.sinner@nrel.gov `_.