diff --git a/README.md b/README.md index 375aee7f..e50dd56c 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ configs directory: cp -r configs.example configs ``` -You will be making local amendments to these configs. See the README in +You will be making local amendments to these configs. See the README in `configs.example` for more info. ### Datasets @@ -339,5 +339,3 @@ python run.py ## Testing You can use `python -m pytest tests` to run tests - - diff --git a/configs.example/datamodule/configuration/gcp_configuration.yaml b/configs.example/datamodule/configuration/gcp_configuration.yaml index 3e81d8dc..f297df10 100644 --- a/configs.example/datamodule/configuration/gcp_configuration.yaml +++ b/configs.example/datamodule/configuration/gcp_configuration.yaml @@ -381,43 +381,42 @@ input_data: time_resolution_minutes: 5 nwp: - ukv: - nwp_zarr_path: - # Path(s) to UKV NWP data in zarr format - # e.g. gs://solar-pv-nowcasting-data/NWP/UK_Met_Office/UKV_intermediate_version_7.zarr - - PLACEHOLDER.zarr - history_minutes: 120 - forecast_minutes: 480 - time_resolution_minutes: 60 - nwp_channels: - - t # 2-metre temperature - - dswrf # downwards short-wave radiation flux - - dlwrf # downwards long-wave radiation flux - - hcc # high cloud cover - - mcc # medium cloud cover - - lcc # low cloud cover - nwp_image_size_pixels_height: 24 - nwp_image_size_pixels_width: 24 - nwp_provider: ukv - + nwp_zarr_path: + # Path(s) to UKV NWP data in zarr format + # e.g. gs://solar-pv-nowcasting-data/NWP/UK_Met_Office/UKV_intermediate_version_7.zarr + - PLACEHOLDER.zarr + history_minutes: 120 + forecast_minutes: 480 + time_resolution_minutes: 60 + nwp_channels: + - t # 2-metre temperature + - dswrf # downwards short-wave radiation flux + - dlwrf # downwards long-wave radiation flux + - hcc # high cloud cover + - mcc # medium cloud cover + - lcc # low cloud cover + nwp_image_size_pixels_height: 24 + nwp_image_size_pixels_width: 24 + nwp_provider: ukv + ecmwf: - # Path to ECMWF NWP data in zarr format - # n.b. It is not necessary to use multiple or any NWP data. These entries can be removed - nwp_zarr_path: PLACEHOLDER.zarr - history_minutes: 120 - forecast_minutes: 480 - time_resolution_minutes: 60 - nwp_channels: - - t2m # 2-metre temperature - - dswrf # downwards short-wave radiation flux - - dlwrf # downwards long-wave radiation flux - - hcc # high cloud cover - - mcc # medium cloud cover - - lcc # low cloud cover - nwp_image_size_pixels_height: 12 # roughtly equivalent to ukv 24 pixels - nwp_image_size_pixels_width: 12 - nwp_provider: ecmwf + # Path to ECMWF NWP data in zarr format + # n.b. It is not necessary to use multiple or any NWP data. These entries can be removed + nwp_zarr_path: PLACEHOLDER.zarr + history_minutes: 120 + forecast_minutes: 480 + time_resolution_minutes: 60 + nwp_channels: + - t2m # 2-metre temperature + - dswrf # downwards short-wave radiation flux + - dlwrf # downwards long-wave radiation flux + - hcc # high cloud cover + - mcc # medium cloud cover + - lcc # low cloud cover + nwp_image_size_pixels_height: 12 # roughtly equivalent to ukv 24 pixels + nwp_image_size_pixels_width: 12 + nwp_provider: ecmwf satellite: satellite_zarr_path: diff --git a/configs.example/datamodule/configuration/template_configuration.yaml b/configs.example/datamodule/configuration/template_configuration.yaml index 9add61ec..559f9d7f 100644 --- a/configs.example/datamodule/configuration/template_configuration.yaml +++ b/configs.example/datamodule/configuration/template_configuration.yaml @@ -70,7 +70,5 @@ input_data: satellite_image_size_pixels_height: 24 satellite_image_size_pixels_width: 24 - - output_data: filepath: "not-needed" diff --git a/configs.example/datamodule/streamed_batches.yaml b/configs.example/datamodule/streamed_batches.yaml index 42eac9e7..1b05f323 100644 --- a/configs.example/datamodule/streamed_batches.yaml +++ b/configs.example/datamodule/streamed_batches.yaml @@ -6,11 +6,11 @@ num_workers: 20 prefetch_factor: 2 batch_size: 8 train_period: - - null - - '2022-05-07' + - null + - "2022-05-07" val_period: - - '2022-05-08' - - '2023-05-08' + - "2022-05-08" + - "2023-05-08" test_period: - - '2022-05-08' - - '2023-05-08' \ No newline at end of file + - "2022-05-08" + - "2023-05-08" diff --git a/configs.example/readme.md b/configs.example/readme.md index 292c3e1e..36bddee5 100644 --- a/configs.example/readme.md +++ b/configs.example/readme.md @@ -1,6 +1,6 @@ This directory contains example configuration files for the PVNet project. Many paths will need to be each user. YOu can find these paths by searching for PLACEHOLDER within these logs. Not all of -the values with a placeholder need to be set. For example in the logger subdirectory there are +the values with a placeholder need to be set. For example in the logger subdirectory there are many different loggers with PLACEHOLDERS. If only one logger is used, then only that placeholder need be set.