Deprecate Configuration.library_path (#122)

* depreacte configuration library requirement * update documentation
WISDEM · Oct 23, 2023 · 20fcb13 · 20fcb13
1 parent e4591f4
commit 20fcb13
Show file tree

Hide file tree

Showing 4 changed files with 829 additions and 909 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@
   - `plot_farm_availability` plots a line chart of the monthly overall windfarm availability. Additional toggles allow for the plotting of individual turbines in the background and/or the a 95% confidence interval band around the farm's availability
   - `plot_detailed_availability` plots a heatmap of the hourly turbine and farm operational levels to help in debugging simulations where availability may be running suspiciously low (i.e., a turbine might have shut down or a cable failure didn't get repaired within a reasonable time frame).
 - `Simulation.service_equipment` is now a dictionary to provide clear access to the servicing equipment details.
+- `Simulation.from_config()` requires both a library input and a file name input for the configuration after deprecating the `library` field from the configuration requirements due to it being cumbersome
 
 ### Methodology Updates
 
@@ -29,6 +30,7 @@
 ### Deprecations
 
 - The original library structure has been fully deprecated, please see the Reference/How To example for more details on converting data that has not yet been updated.
+- The `Simulation.config` no longer requires the `library` field to reduce conflicts with sharing data between users.
 
 ## v0.8.1 (28 August 2023)