Merge pull request #117 from misi9170/enhancement/reorganize-examples

[Enhancement] Reorganize artifical data examples to make them easier to follow
NREL · Aug 31, 2023 · 685871d · 685871d
2 parents 1401334 + d35c15e
commit 685871d
Show file tree

Hide file tree

Showing 60 changed files with 4,414 additions and 4,403 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -2,16 +2,17 @@
 Credits
 =======
 
-Development Lead
+Development Leads
 ----------------
 
-* Bart Doekemeijer <Bart.Doekemeijer@nrel.gov>
-
+* Bart Doekemeijer
+* Paul Fleming
 
 
 Contributors
 ------------
 
 * Paul Fleming <paul.fleming@nrel.gov>
 * Eric Simley <eric.simley@nrel.gov>
-* Christopher Bay <Christopher.Bay@nrel.gov>
+* Christopher Bay <christopher.bay@nrel.gov>
+* Misha Sinner <michael.sinner@nrel.gov>
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,8 +18,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'flasc'
-copyright = '2022, Bart Doekemeijer, Paul Fleming, Eric Simley'
-author = 'Bart Doekemeijer, Paul Fleming, Eric Simley'
+copyright = '2022, Bart Doekemeijer, Paul Fleming, Eric Simley, Michael Sinner'
+author = 'Bart Doekemeijer, Paul Fleming, Eric Simley, Michael Sinner'
 
 # The full version, including alpha/beta/rc tags
 release = '1.1'

diff --git a/docs/source/licensing.rst b/docs/source/licensing.rst
@@ -3,8 +3,8 @@ Licensing
 -----------------
 The FLASC repository has been licensed under the Apache License.
 For more information, contact the NREL FLASC team at
-`bart.doekemeijer@nrel.gov <mailto:bart.doekemeijer@nrel.gov>`_, or
-`paul.fleming@nrel.gov <mailto:paul.fleming@nrel.gov>`_.
+`paul.fleming@nrel.gov <mailto:paul.fleming@nrel.gov>`_ or
+`michael.sinner@nrel.gov <mailto:michael.sinner@nrel.gov>`_.
 
 .. code-block:: bash
 

diff --git a/docs/source/overview.rst b/docs/source/overview.rst
@@ -45,8 +45,8 @@ 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
-`bart.doekemeijer@nrel.gov <mailto:bart.doekemeijer@nrel.gov>`_, or
-`paul.fleming@nrel.gov <mailto:paul.fleming@nrel.gov>`_.
+`paul.fleming@nrel.gov <mailto:paul.fleming@nrel.gov>`_ or
+`michael.sinner@nrel.gov <mailto:michael.sinner@nrel.gov>`_.
 
 
 Module overview

diff --git a/...ta/setup_floris_model/visualize_layout.py → ...setup_floris_model/00_visualize_layout.py b/...ta/setup_floris_model/visualize_layout.py → ...setup_floris_model/00_visualize_layout.py
@@ -22,7 +22,7 @@
     shade_region
 )
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 # Example demonstrates some methods for visualizing the layout of the farm

diff --git a/...setup_floris_model/visualize_flowfield.py → ...up_floris_model/01_visualize_flowfield.py b/...setup_floris_model/visualize_flowfield.py → ...up_floris_model/01_visualize_flowfield.py
@@ -4,7 +4,7 @@
 from flasc.visualization import plot_floris_layout, plot_layout_only
 from floris.tools.visualization import visualize_cut_plane
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 if __name__ == "__main__":

diff --git a/...is_model/precalculate_floris_solutions.py → ...model/02_precalculate_floris_solutions.py b/...is_model/precalculate_floris_solutions.py → ...model/02_precalculate_floris_solutions.py
@@ -5,7 +5,7 @@
 from floris.tools import ParallelComputingInterface
 from flasc import floris_tools as ftools
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 if __name__ == "__main__":

diff --git a/...ris_model/compute_turbine_dependencies.py → ..._model/03_compute_turbine_dependencies.py b/...ris_model/compute_turbine_dependencies.py → ..._model/03_compute_turbine_dependencies.py
@@ -5,7 +5,7 @@
 from flasc import floris_tools as fsatools
 from flasc import visualization as fsaviz
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 # Demonstrate the turbine dependency functions in floris_tools
 # Note a turbine is "dependent" on another if it is affected 

diff --git a/...a_processing/filter_ws_power_curves.ipynb → ...rocessing/00_filter_ws_power_curves.ipynb b/...a_processing/filter_ws_power_curves.ipynb → ...rocessing/00_filter_ws_power_curves.ipynb
diff --git a/examples_artificial_data/01_raw_data_processing/01_northing_calibration.ipynb b/examples_artificial_data/01_raw_data_processing/01_northing_calibration.ipynb
diff --git a/...a_processing/data/raw_artificial_data.zip → ...a_processing/data/raw_artificial_data.zip b/...a_processing/data/raw_artificial_data.zip → ...a_processing/data/raw_artificial_data.zip
diff --git a/...g_design/00_analyze_single_ws_vs_range.py → ...g_design/00_analyze_single_ws_vs_range.py b/...g_design/00_analyze_single_ws_vs_range.py → ...g_design/00_analyze_single_ws_vs_range.py
@@ -19,7 +19,7 @@
     plot_uplifts_by_atmospheric_conditions, plot_offsets_wswd_heatmap, plot_offsets_wd
 from flasc.visualization import plot_floris_layout, plot_layout_with_waking_directions
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 from _local_helper_functions import optimize_yaw_angles, evaluate_optimal_yaw_angles
 
 

diff --git a/...e_steering_design/01_analyze_pP_values.py → ...e_steering_design/01_analyze_pP_values.py b/...e_steering_design/01_analyze_pP_values.py → ...e_steering_design/01_analyze_pP_values.py
@@ -18,7 +18,7 @@
 
 from flasc.wake_steering.lookup_table_tools import get_yaw_angles_interpolant
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 from _local_helper_functions import optimize_yaw_angles, evaluate_optimal_yaw_angles
 
 

diff --git a/...eering_design/02_analyze_wdstd_choices.py → ...eering_design/02_analyze_wdstd_choices.py b/...eering_design/02_analyze_wdstd_choices.py → ...eering_design/02_analyze_wdstd_choices.py
@@ -18,7 +18,7 @@
 
 from floris.tools.uncertainty_interface import UncertaintyInterface
 from flasc.wake_steering.lookup_table_tools import get_yaw_angles_interpolant
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 from _local_helper_functions import optimize_yaw_angles, evaluate_optimal_yaw_angles
 

diff --git a/..._steering_design/03_analyze_ti_choices.py → ..._steering_design/03_analyze_ti_choices.py b/..._steering_design/03_analyze_ti_choices.py → ..._steering_design/03_analyze_ti_choices.py
@@ -17,7 +17,7 @@
 import seaborn as sns
 
 from flasc.wake_steering.lookup_table_tools import get_yaw_angles_interpolant
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 from _local_helper_functions import optimize_yaw_angles, evaluate_optimal_yaw_angles
 

diff --git a/...g_design/04_analyze_table_ramp_choices.py → ...g_design/04_analyze_table_ramp_choices.py b/...g_design/04_analyze_table_ramp_choices.py → ...g_design/04_analyze_table_ramp_choices.py
@@ -17,7 +17,7 @@
 import seaborn as sns
 
 from flasc.wake_steering.lookup_table_tools import get_yaw_angles_interpolant
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 from _local_helper_functions import optimize_yaw_angles, evaluate_optimal_yaw_angles
 

diff --git a/...ial_data/wake_steering_design/__init__.py → ..._data/02_wake_steering_design/__init__.py b/...ial_data/wake_steering_design/__init__.py → ..._data/02_wake_steering_design/__init__.py
diff --git a/...teering_design/_local_helper_functions.py → ...teering_design/_local_helper_functions.py b/...teering_design/_local_helper_functions.py → ...teering_design/_local_helper_functions.py
@@ -22,7 +22,7 @@
 from floris.tools.uncertainty_interface import UncertaintyInterface
 from floris.tools.optimization.yaw_optimization.yaw_optimizer_sr import YawOptimizationSR
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 def load_wind_climate_interpolant():

diff --git a/examples_artificial_data/03_energy_ratio/00_demo_energy_ratio_syntax.ipynb b/examples_artificial_data/03_energy_ratio/00_demo_energy_ratio_syntax.ipynb
diff --git a/examples_artificial_data/03_energy_ratio/01_demo_energy_ratio_options.ipynb b/examples_artificial_data/03_energy_ratio/01_demo_energy_ratio_options.ipynb
diff --git a/...ratio/energy_ratio_vs_wd_for_single_df.py → ...io/02_energy_ratio_vs_wd_for_single_df.py b/...ratio/energy_ratio_vs_wd_for_single_df.py → ...io/02_energy_ratio_vs_wd_for_single_df.py
@@ -21,14 +21,15 @@
 from flasc.dataframe_operations import \
     dataframe_manipulations as dfm
 from flasc import floris_tools as fsatools
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 def load_data():
     # Load dataframe with artificial SCADA data
     root_dir = os.path.dirname(os.path.abspath(__file__))
     ftr_path = os.path.join(
-        root_dir, '..', 'raw_data_processing', 'postprocessed', 'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
+        root_dir, '..', '01_raw_data_processing', 'postprocessed',
+        'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
     )
     if not os.path.exists(ftr_path):
         raise FileNotFoundError(

diff --git a/...io/energy_ratio_vs_wd_for_multiple_dfs.py → ...03_energy_ratio_vs_wd_for_multiple_dfs.py b/...io/energy_ratio_vs_wd_for_multiple_dfs.py → ...03_energy_ratio_vs_wd_for_multiple_dfs.py
@@ -23,14 +23,15 @@
 from flasc.dataframe_operations import \
     dataframe_manipulations as dfm
 from flasc import floris_tools as fsatools
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 def load_data():
     # Load dataframe with artificial SCADA data
     root_dir = os.path.dirname(os.path.abspath(__file__))
     ftr_path = os.path.join(
-        root_dir, '..', 'raw_data_processing', 'postprocessed', 'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
+        root_dir, '..', '01_raw_data_processing', 'postprocessed',
+        'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
     )
     if not os.path.exists(ftr_path):
         raise FileNotFoundError(

diff --git a/...gy_ratio/energy_ratio_in_turbine_array.py → ...ratio/04_energy_ratio_in_turbine_array.py b/...gy_ratio/energy_ratio_in_turbine_array.py → ...ratio/04_energy_ratio_in_turbine_array.py
@@ -21,7 +21,7 @@
 from flasc.energy_ratio import energy_ratio as er
 from flasc.energy_ratio.energy_ratio_input import EnergyRatioInput
 from flasc.visualization import plot_floris_layout
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 from floris.tools.visualization import visualize_cut_plane
 from floris.utilities import wrap_360
@@ -31,7 +31,8 @@ def load_data():
     # Load dataframe with artificial SCADA data
     root_dir = os.path.dirname(os.path.abspath(__file__))
     ftr_path = os.path.join(
-        root_dir, '..', 'raw_data_processing', 'postprocessed', 'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
+        root_dir, '..', '01_raw_data_processing', 'postprocessed',
+        'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
     )
     if not os.path.exists(ftr_path):
         raise FileNotFoundError(

diff --git a/...imate_heterogeneity_from_energy_ratios.py → ...imate_heterogeneity_from_energy_ratios.py b/...imate_heterogeneity_from_energy_ratios.py → ...imate_heterogeneity_from_energy_ratios.py
@@ -10,14 +10,15 @@
 from flasc.energy_ratio import energy_ratio as er
 from flasc.energy_ratio.energy_ratio_input import EnergyRatioInput
 from flasc.visualization import plot_floris_layout
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 def load_data():
     # Load dataframe with artificial SCADA data
     root_dir = os.path.dirname(os.path.abspath(__file__))
     ftr_path = os.path.join(
-        root_dir, '..', 'raw_data_processing', 'postprocessed', 'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
+        root_dir, '..', '01_raw_data_processing', 'postprocessed',
+        'df_scada_data_600s_filtered_and_northing_calibrated.ftr'
     )
     if not os.path.exists(ftr_path):
         raise FileNotFoundError(

diff --git a/...ata/energy_ratio/wake_steering_example.py → ..._energy_ratio/05_wake_steering_example.py b/...ata/energy_ratio/wake_steering_example.py → ..._energy_ratio/05_wake_steering_example.py
@@ -23,7 +23,7 @@
 from flasc.energy_ratio.energy_ratio_input import EnergyRatioInput
 # from flasc import floris_tools as fsatools
 from flasc.visualization import plot_layout_with_waking_directions, plot_binned_mean_and_ci
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 
 
 if __name__ == "__main__":

diff --git a/examples_artificial_data/_legacy/table_analysis/energy_table_for_two_df.py b/examples_artificial_data/_legacy/table_analysis/energy_table_for_two_df.py
@@ -9,7 +9,7 @@
     dataframe_manipulations as dfm,
 )
 
-from flasc.examples.models import load_floris_artificial as load_floris
+from flasc.utilities_examples import load_floris_artificial as load_floris
 from flasc import floris_tools as fsatools
 
 

diff --git a/examples_artificial_data/energy_ratio/00_demo_energy_ratio_syntax.ipynb b/examples_artificial_data/energy_ratio/00_demo_energy_ratio_syntax.ipynb
diff --git a/examples_artificial_data/energy_ratio/01_demo_energy_ratio_options.ipynb b/examples_artificial_data/energy_ratio/01_demo_energy_ratio_options.ipynb
diff --git a/.../examples/floris_input_artificial/cc.yaml → ...cial_data/floris_input_artificial/cc.yaml b/.../examples/floris_input_artificial/cc.yaml → ...cial_data/floris_input_artificial/cc.yaml
diff --git a/...examples/floris_input_artificial/gch.yaml → ...ial_data/floris_input_artificial/gch.yaml b/...examples/floris_input_artificial/gch.yaml → ...ial_data/floris_input_artificial/gch.yaml
diff --git a/...mples/floris_input_artificial/jensen.yaml → ..._data/floris_input_artificial/jensen.yaml b/...mples/floris_input_artificial/jensen.yaml → ..._data/floris_input_artificial/jensen.yaml
diff --git a/...es/floris_input_artificial/turbopark.yaml → ...ta/floris_input_artificial/turbopark.yaml b/...es/floris_input_artificial/turbopark.yaml → ...ta/floris_input_artificial/turbopark.yaml