docs - whatsnew

Author: tobin-ford

docs/source/_autosummary/pvdeg.scenario.rst

@@ -25,13 +25,6 @@ pvdeg.scenario
    -------
 
 
-   .. autoclass:: GeospatialScenario
-      :members:
-
-   .. _sphx_glr_backref_pvdeg.scenario.GeospatialScenario:
-
-   .. minigallery:: pvdeg.scenario.GeospatialScenario
-       :add-heading:
    .. autoclass:: Scenario
       :members:
 

docs/source/whatsnew/index.rst

@@ -4,6 +4,7 @@ What's New
 ==========
 PVDegradationTools (pvdeg) change log:
 
+.. include:: releases/v0.5.1.rst
 .. include:: releases/v0.5.0.rst
 .. include:: releases/v0.4.3.rst
 .. include:: releases/v0.4.2.rst

docs/source/whatsnew/releases/v0.5.1.rst

@@ -0,0 +1,23 @@
+v0.5.1 (2025-2-28)
+===================
+
+Enhancements
+--------------
+- Changed ``GeospatialScenario.get_geospatial_data()`` to a ``@property``, now use ``GeospatialScenario.geospatial_data``
+- Changed ``GeospatialScenario.coords_tonumpy()`` to a ``@property``, now use ``GeospatialScenario.coords``
+
+Deprecations
+-------------
+- ``GeospatialScenario._get_geospatial_data()``
+- ``GeospatialScenario.getValidRegions()``
+- ``GeospatialScenario.gids_tonumpy()``
+- ``GeospatialScenario.gids_tolist()``
+
+Bug Fixes
+---------
+``v0.5.0`` incorrectly claimed that ``GeospatialScenario`` was moved to ``pvdeg/geospatialscenario.py``. Completed the move.
+
+
+Contributors
+-----------
+- Tobin Ford (:ghuser:`tobin-ford`)

pvdeg/geospatialscenario.py

@@ -760,7 +760,7 @@ def restore_result_gids(self):
 
         self.results = self.results.assign(gids=gids_da)
 
-    @pvdeg.decorators.deprecated("to be removed shortly")
+    @pvdeg.decorators.deprecated("removing complexity")
     def _get_geospatial_data(year: int):
         """
         Helper function. gets geospatial weather dataset and metadata dictionary.
@@ -793,7 +793,7 @@ def _get_geospatial_data(year: int):
 
         return weather_ds, meta_df
 
-    @pvdeg.decorators.deprecated("function to be removed")
+    @pvdeg.decorators.deprecated("removing co")
     def getValidRegions(
         self,
         country: Optional[str] = None,