Bring all Analysis Modules up to v3 spec with speed/readability improvements (#212)

* rename ._plant to .plant

* update reanalysis products naming

* update _aggregate and refactor MonteCarloAEP to attrs

* update initialization and removal of unnecessary shortening

* update examples for renaming

* continue renaming unnecessary dunders and shortening, and initializations

* reorganizing and simplifying code and getting initialization working

* update minor formatting and bugs

* fix data persistency bug causing tests to fail

* add final AEP changes before needing to stop

* make electrical losses an attrs dataclass and sort out inputs

* add power-energy conversion and continue refactoring elect. losses

* add s to turbine_id and tower_id

* update EL routines and add a plot to the class

* update EL tests

* add styling method call to plotting

* add frequency checks to the timeseries module

* address edge cases in offset to seconds conversion

* implement proper frequency checking

* complete data validation

* update regression tests for validation and implement plant validator in AEP

* make integer conversion robust

* update test to adjust for energy col

* merged aep_v3_refactor branch with rhammond pull request 212. This brings in a fix for the structure of the logger, which allows us to attach analysis classes to the openoa object in init. For some reason the electrical losses test is now failing

* refactor basic input format of EYA class

* fix bug inducing typo in setup_inputs

* get eya init running

* start plot refactor

* add timeseries method

* start turbine loss refactor into attrs with v3 api

* bring turbine energy up to v3 in theory

* update for common validations and to get turbine energy almost working

* finish basic refactor of TIE and add tests

* update analysis notebooks

* remove notebook file outputs

* add missing class to init

* get all but the intro examples working again and refactor waterfall plot

* minor unsaved updates

* tidy up plotting API and routines for analysis classes

* debugging QA code to find issues

* fix documentation build issues

* rerun examples

* cleanup the analysis docs

* finish plotting refactor for analysis methods

* update examples docs layout

* tidy up examples presentation and docs build issues

* update working and rerun examples

* fix unit test for net_energy removal from curtail

* fix tests

* continue debugging QA, though there is some data modification happening improperly

* fix QA bug with timestamps and rerun notebook

* tidy up examples page

Co-authored-by: Jordan Perr-Sauer <[email protected]>

Author: RHammond2

examples/00_intro_to_plant_data.ipynb

@@ -99,7 +99,7 @@
     "# Load meta data\n",
     "plant._lat_lon = (48.452, 5.588)\n",
     "plant._plant_capacity = 8.2 # MW\n",
-    "plant._num_turbines = 4\n",
+    "plant.n_turbines = 4\n",
     "plant._turbine_capacity = 2.05 # MW\n",
     "\n",
     "\n",

examples/00_toolkit_examples_entr.ipynb

@@ -738,7 +738,7 @@
     "            \"columns\": [\"windspeed\", \"rho\"],\n",
     "            \"conditional_columns\": {\n",
     "                \"reg_temperature\": [\"temperature\"],\n",
-    "                \"reg_winddirection\": [\"windspeed_u\", \"windspeed_v\"],\n",
+    "                \"reg_wind_direction\": [\"windspeed_u\", \"windspeed_v\"],\n",
     "            },\n",
     "        },\n",
     "    },\n",

examples/00_v3_demonstration.ipynb

@@ -128,16 +128,16 @@
    ],
    "source": [
     "pa_lin = plant_analysis.MonteCarloAEP(project, reanal_products = ['merra2','era5'], time_resolution = 'M',\n",
-    "                                    reg_temperature = False, reg_winddirection = False, reg_model = 'lin')\n",
+    "                                    reg_temperature = False, reg_wind_direction = False, reg_model = 'lin')\n",
     "\n",
     "pa_gam = plant_analysis.MonteCarloAEP(project, reanal_products = ['merra2','era5'], time_resolution = 'H',\n",
-    "                                     reg_temperature = False, reg_winddirection = False, reg_model = 'gam')\n",
+    "                                     reg_temperature = False, reg_wind_direction = False, reg_model = 'gam')\n",
     "\n",
     "pa_gbm = plant_analysis.MonteCarloAEP(project, reanal_products = ['merra2','era5'], time_resolution = 'D', \n",
-    "                                         reg_temperature = False, reg_winddirection = False, reg_model = 'gbm')\n",
+    "                                         reg_temperature = False, reg_wind_direction = False, reg_model = 'gbm')\n",
     "\n",
     "pa_etr = plant_analysis.MonteCarloAEP(project, reanal_products = ['merra2','era5'], time_resolution = 'D',\n",
-    "                                            reg_temperature = False, reg_winddirection = False, reg_model = 'etr')"
+    "                                            reg_temperature = False, reg_wind_direction = False, reg_model = 'etr')"
    ]
   },
   {
@@ -368,7 +368,7 @@
    ],
    "source": [
     "# View the monthly data frame\n",
-    "pa_lin._aggregate.df.head()"
+    "pa_lin.aggregate.df.head()"
    ]
   },
   {
@@ -390,10 +390,10 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 1000, 'reanal_subset': ['merra2', 'era5']}\n",
+      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 1000, 'reanalysis_subset': ['merra2', 'era5']}\n",
       "100%|██████████| 1000/1000 [00:29<00:00, 33.89it/s]\n",
       "INFO:openoa.methods.plant_analysis:Run completed\n",
-      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanal_subset': ['merra2', 'era5']}\n",
+      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanalysis_subset': ['merra2', 'era5']}\n",
       "  0%|          | 0/500 [00:00<?, ?it/s]"
      ]
     },
@@ -424,7 +424,7 @@
      "text": [
       "100%|██████████| 500/500 [05:00<00:00,  1.66it/s]\n",
       "INFO:openoa.methods.plant_analysis:Run completed\n",
-      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanal_subset': ['merra2', 'era5']}\n",
+      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanalysis_subset': ['merra2', 'era5']}\n",
       "  0%|          | 0/500 [00:00<?, ?it/s]"
      ]
     },
@@ -455,7 +455,7 @@
      "text": [
       "100%|██████████| 500/500 [04:09<00:00,  2.01it/s]\n",
       "INFO:openoa.methods.plant_analysis:Run completed\n",
-      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanal_subset': ['merra2', 'era5']}\n",
+      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanalysis_subset': ['merra2', 'era5']}\n",
       "  0%|          | 0/500 [00:00<?, ?it/s]"
      ]
     },
@@ -621,7 +621,7 @@
    "metadata": {},
    "source": [
     "The augmented capabilities of the AEP class now allow the user to include temperature and/or wind direction as additional inputs to the long-term OA. \n",
-    "This choice is controlled by the booleans \"reg_temperature\" and \"reg_winddirection\".\n",
+    "This choice is controlled by the booleans \"reg_temperature\" and \"reg_wind_direction\".\n",
     "In this example, we will compute AEP using a multivariate hourly GAM regression, including wind speed and temperature as inputs, and compare the results with the univariate GAM applied in the previous comparison."
    ]
   },
@@ -640,7 +640,7 @@
    ],
    "source": [
     "pa_gam_T = plant_analysis.MonteCarloAEP(project, reanal_products = ['merra2','era5'], time_resolution = 'H',\n",
-    "                                     reg_temperature = True, reg_winddirection = False, reg_model = 'gam')"
+    "                                     reg_temperature = True, reg_wind_direction = False, reg_model = 'gam')"
    ]
   },
   {
@@ -659,7 +659,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanal_subset': ['merra2', 'era5']}\n",
+      "INFO:openoa.methods.plant_analysis:Running with parameters: {'uncertainty_meter': 0.005, 'uncertainty_losses': 0.05, 'uncertainty_loss_max': array([10., 20.]), 'uncertainty_windiness': array([10., 20.]), 'uncertainty_nan_energy': 0.01, 'num_sim': 500, 'reanalysis_subset': ['merra2', 'era5']}\n",
       "  0%|          | 0/500 [00:00<?, ?it/s]"
      ]
     },