PVNet 3.0.36__tar.gz → 3.0.38__tar.gz

{pvnet-3.0.36 → pvnet-3.0.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PVNet
-Version: 3.0.36
+Version: 3.0.38
 Summary: PVNet
 Author-email: Peter Dudfield <info@openclimatefix.org>
 Description-Content-Type: text/markdown
@@ -65,12 +65,12 @@ together.
 
 ## Experiments
 
-**Link to our workshop paper coming soon**
+Our paper based on this repo was accepted into the Tackling Climate Change with Machine Learning workshop at ICLR 2024 and can be viewed [here](https://www.climatechange.ai/papers/iclr2024/46).
 
-Some very rough working notes on this model are
-[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA/edit?usp=sharing).
+Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg).
 
-Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg/edit?usp=sharing)
+Some very rough, early working notes on this model are
+[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA). These are now somewhat out of date.
 
 
 
@@ -200,10 +200,15 @@ Where `FULL-PATH-TO-REPO` represent the whole path to the PVNet repo on your loc
 
 ### Running the batch creation script
 
-Run the save_batches.py script to create batches with the following example arguments as:
+Run the save_batches.py script to create batches if setting parameters in the datamodule config (`streamed_batches.yaml` in this example):
 
 ```
-python scripts/save_batches.py datamodule=streamed_batches +batch_output_dir="./output" +num_train_batches=10 +num_val_batches=5
+python scripts/save_batches.py
+```
+or with the following example arguments to override config:
+
+```
+python scripts/save_batches.py datamodule=streamed_batches datamodule.batch_output_dir="./output" datamodule.num_train_batches=10 datamodule.num_val_batches=5
 ```
 
 In this function the datamodule argument looks for a config under `PVNet/configs/datamodule`. The examples here are either to use "premade_batches" or "streamed_batches".
@@ -391,6 +396,11 @@ val data batches, you can now train PVNet by running:
 python run.py
 ```
 
+## Backtest
+
+If you have succesfully trained a PVNet model and have a saved model checkpoint you can create a backtest using this, e.g. forecasts on historical data to evaluate forecast accuracy/skill. This can be done by running one of the scripts in this repo such as [the UK gsp backtest script](scripts/backtest_uk_gsp.py) or the [the pv site backtest script](scripts/backtest_sites.py), further info on how to run these are in each backtest file.
+
+
 ## Testing
 
 You can use `python -m pytest tests` to run tests

{pvnet-3.0.36 → pvnet-3.0.38}/PVNet.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PVNet
-Version: 3.0.36
+Version: 3.0.38
 Summary: PVNet
 Author-email: Peter Dudfield <info@openclimatefix.org>
 Description-Content-Type: text/markdown
@@ -65,12 +65,12 @@ together.
 
 ## Experiments
 
-**Link to our workshop paper coming soon**
+Our paper based on this repo was accepted into the Tackling Climate Change with Machine Learning workshop at ICLR 2024 and can be viewed [here](https://www.climatechange.ai/papers/iclr2024/46).
 
-Some very rough working notes on this model are
-[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA/edit?usp=sharing).
+Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg).
 
-Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg/edit?usp=sharing)
+Some very rough, early working notes on this model are
+[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA). These are now somewhat out of date.
 
 
 
@@ -200,10 +200,15 @@ Where `FULL-PATH-TO-REPO` represent the whole path to the PVNet repo on your loc
 
 ### Running the batch creation script
 
-Run the save_batches.py script to create batches with the following example arguments as:
+Run the save_batches.py script to create batches if setting parameters in the datamodule config (`streamed_batches.yaml` in this example):
 
 ```
-python scripts/save_batches.py datamodule=streamed_batches +batch_output_dir="./output" +num_train_batches=10 +num_val_batches=5
+python scripts/save_batches.py
+```
+or with the following example arguments to override config:
+
+```
+python scripts/save_batches.py datamodule=streamed_batches datamodule.batch_output_dir="./output" datamodule.num_train_batches=10 datamodule.num_val_batches=5
 ```
 
 In this function the datamodule argument looks for a config under `PVNet/configs/datamodule`. The examples here are either to use "premade_batches" or "streamed_batches".
@@ -391,6 +396,11 @@ val data batches, you can now train PVNet by running:
 python run.py
 ```
 
+## Backtest
+
+If you have succesfully trained a PVNet model and have a saved model checkpoint you can create a backtest using this, e.g. forecasts on historical data to evaluate forecast accuracy/skill. This can be done by running one of the scripts in this repo such as [the UK gsp backtest script](scripts/backtest_uk_gsp.py) or the [the pv site backtest script](scripts/backtest_sites.py), further info on how to run these are in each backtest file.
+
+
 ## Testing
 
 You can use `python -m pytest tests` to run tests

{pvnet-3.0.36 → pvnet-3.0.38}/PVNet.egg-info/SOURCES.txt

@@ -42,4 +42,5 @@ pvnet/models/multimodal/linear_networks/networks.py
 pvnet/models/multimodal/site_encoders/__init__.py
 pvnet/models/multimodal/site_encoders/basic_blocks.py
 pvnet/models/multimodal/site_encoders/encoders.py
-tests/test_end2end.py
+tests/test_end2end.py
+tests/test_utils.py

{pvnet-3.0.36 → pvnet-3.0.38}/README.md

@@ -17,12 +17,12 @@ together.
 
 ## Experiments
 
-**Link to our workshop paper coming soon**
+Our paper based on this repo was accepted into the Tackling Climate Change with Machine Learning workshop at ICLR 2024 and can be viewed [here](https://www.climatechange.ai/papers/iclr2024/46).
 
-Some very rough working notes on this model are
-[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA/edit?usp=sharing).
+Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg).
 
-Some slightly more structured notes on deliberate experiments we have performed with PVNet are [here](https://docs.google.com/document/d/1VumDwWd8YAfvXbOtJEv3ZJm_FHQDzrKXR0jU9vnvGQg/edit?usp=sharing)
+Some very rough, early working notes on this model are
+[here](https://docs.google.com/document/d/1fbkfkBzp16WbnCg7RDuRDvgzInA6XQu3xh4NCjV-WDA). These are now somewhat out of date.
 
 
 
@@ -152,10 +152,15 @@ Where `FULL-PATH-TO-REPO` represent the whole path to the PVNet repo on your loc
 
 ### Running the batch creation script
 
-Run the save_batches.py script to create batches with the following example arguments as:
+Run the save_batches.py script to create batches if setting parameters in the datamodule config (`streamed_batches.yaml` in this example):
 
 ```
-python scripts/save_batches.py datamodule=streamed_batches +batch_output_dir="./output" +num_train_batches=10 +num_val_batches=5
+python scripts/save_batches.py
+```
+or with the following example arguments to override config:
+
+```
+python scripts/save_batches.py datamodule=streamed_batches datamodule.batch_output_dir="./output" datamodule.num_train_batches=10 datamodule.num_val_batches=5
 ```
 
 In this function the datamodule argument looks for a config under `PVNet/configs/datamodule`. The examples here are either to use "premade_batches" or "streamed_batches".
@@ -343,6 +348,11 @@ val data batches, you can now train PVNet by running:
 python run.py
 ```
 
+## Backtest
+
+If you have succesfully trained a PVNet model and have a saved model checkpoint you can create a backtest using this, e.g. forecasts on historical data to evaluate forecast accuracy/skill. This can be done by running one of the scripts in this repo such as [the UK gsp backtest script](scripts/backtest_uk_gsp.py) or the [the pv site backtest script](scripts/backtest_sites.py), further info on how to run these are in each backtest file.
+
+
 ## Testing
 
 You can use `python -m pytest tests` to run tests

pvnet-3.0.38/pvnet/__init__.py

@@ -0,0 +1,2 @@
+"""PVNet"""
+__version__ = "3.0.38"

{pvnet-3.0.36 → pvnet-3.0.38}/pvnet/data/pv_site_datamodule.py

@@ -34,7 +34,7 @@ class PVSiteDataModule(BaseDataModule):
     def _get_premade_batches_datapipe(self, subdir, shuffle=False):
         filenames = list(glob.glob(f"{self.batch_dir}/{subdir}/*.nc"))
         data_pipeline = pvnet_site_netcdf_datapipe(
-            keys=["pv", "nwp"],
+            keys=["pv", "nwp"],  # add other keys e.g. sat if used as input in site model
             filenames=filenames,
         )
         data_pipeline = (

{pvnet-3.0.36 → pvnet-3.0.38}/pvnet/utils.py

@@ -69,6 +69,34 @@ class GSPLocationLookup:
         )
 
 
+class SiteLocationLookup:
+    """Query object for site location from site ID"""
+
+    def __init__(self, long: xr.DataArray, lat: xr.DataArray):
+        """Query object for site location from site ID
+
+        Args:
+            long: DataArray of the longitude coordinates for any given site ID
+            lat: DataArray of the latitude coordinates for any given site ID
+
+        """
+        self.longitude = long
+        self.latitude = lat
+
+    def __call__(self, site_id: int) -> Location:
+        """Returns the locations for the input site IDs.
+
+        Args:
+            site_id: Integer ID of the site
+        """
+        return Location(
+            coordinate_system="lon_lat",
+            x=self.longitude.sel(pv_system_id=site_id).item(),
+            y=self.latitude.sel(pv_system_id=site_id).item(),
+            id=site_id,
+        )
+
+
 def extras(config: DictConfig) -> None:
     """A couple of optional utilities.
 

pvnet-3.0.38/tests/test_utils.py

@@ -0,0 +1,38 @@
+from ocf_datapipes.utils.location import Location
+from pvnet.utils import SiteLocationLookup
+import xarray as xr
+import pytest
+
+
+@pytest.mark.parametrize(
+    "lookup_site_id, expected_x, expected_y, expected_id",
+    [
+        (1, -1.99106, 48.709865, 1),
+        (0, 0.30693, 51.509865, 0),
+        (2, -1.56106, 56.203865, 2),
+    ],
+)
+def test_site_location_lookup(lookup_site_id, expected_x, expected_y, expected_id):
+    # setup
+    site_ids = [0, 1, 2]
+    longs = [0.30693, -1.99106, -1.56106]
+    lats = [51.509865, 48.709865, 56.203865]
+    da_long = xr.DataArray(
+        data=longs,
+        dims="pv_system_id",
+        coords=dict(site_id=(["pv_system_id"], site_ids), long=(["pv_system_id"], longs)),
+    )
+    da_lat = xr.DataArray(
+        data=lats,
+        dims="pv_system_id",
+        coords=dict(site_id=(["pv_system_id"], site_ids), long=(["pv_system_id"], lats)),
+    )
+    # Actual testing part
+    site_lookup = SiteLocationLookup(long=da_long, lat=da_lat)
+
+    # retrieve location of site 1
+    site_location: Location = site_lookup(lookup_site_id)
+
+    assert site_location.x == expected_x
+    assert site_location.y == expected_y
+    assert site_location.id == expected_id

pvnet-3.0.36/pvnet/__init__.py

@@ -1,2 +0,0 @@
-"""PVNet"""
-__version__ = "3.0.36"