From b45f5813bed0c43df9a48b7ee314fd25f62fd657 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Thu, 24 Jul 2025 12:35:18 +0200 Subject: [PATCH 1/5] add weathersource docs --- .../input/additionaldata/weathersource.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/readthedocs/models/input/additionaldata/weathersource.md diff --git a/docs/readthedocs/models/input/additionaldata/weathersource.md b/docs/readthedocs/models/input/additionaldata/weathersource.md new file mode 100644 index 000000000..90c12aae7 --- /dev/null +++ b/docs/readthedocs/models/input/additionaldata/weathersource.md @@ -0,0 +1,30 @@ +# WeatherSource + +The **`WeatherSource`** is an abstract class that provides a standardized interface for accessing time-series weather data. It serves as a foundation for concrete implementations that fetch data from various providers (e.g., CSV files or SQL databases). + +A `WeatherSource` relies on two key components: +* **[`IdCoordinateSource`](/additionaldata/idcoordinatesource)**: Used to resolve a numeric **coordinate ID** from the source data into a geographic `Point` object. +* **`TimeBasedWeatherValueFactory`**: Used to construct `WeatherValue` objects from the raw data fields. + +*** + +## Information + +The source data for any `WeatherSource` implementation is expected to contain the following information. + +```{list-table} + :widths: auto + :class: wrapping + :header-rows: 1 + + * - Attribute + - Remarks + + * - **`coordinateid`** + - An **integer ID** for a specific geographic coordinate. This ID is used to look up the actual `Point` via the `IdCoordinateSource`. + + * - **Time** + - The specific timestamp of the weather data, typically as a `ZonedDateTime`. + + * - **Weather Data** + - The meteorological values, such as solar irradiance (`direct` and `diffuse`), temperature, and wind data (`speed` and `direction`). \ No newline at end of file From 171a0b59e9f57e581910132a2ecdf0f2210fe993 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Thu, 24 Jul 2025 12:44:20 +0200 Subject: [PATCH 2/5] Fix link and toctree --- docs/readthedocs/models/input/additionaldata/weathersource.md | 2 +- docs/readthedocs/models/models.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/readthedocs/models/input/additionaldata/weathersource.md b/docs/readthedocs/models/input/additionaldata/weathersource.md index 90c12aae7..83a616b73 100644 --- a/docs/readthedocs/models/input/additionaldata/weathersource.md +++ b/docs/readthedocs/models/input/additionaldata/weathersource.md @@ -3,7 +3,7 @@ The **`WeatherSource`** is an abstract class that provides a standardized interface for accessing time-series weather data. It serves as a foundation for concrete implementations that fetch data from various providers (e.g., CSV files or SQL databases). A `WeatherSource` relies on two key components: -* **[`IdCoordinateSource`](/additionaldata/idcoordinatesource)**: Used to resolve a numeric **coordinate ID** from the source data into a geographic `Point` object. +* **[`IdCoordinateSource`](idcoordinatesource.md)**: Used to resolve a numeric **coordinate ID** from the source data into a geographic `Point` object. * **`TimeBasedWeatherValueFactory`**: Used to construct `WeatherValue` objects from the raw data fields. *** diff --git a/docs/readthedocs/models/models.md b/docs/readthedocs/models/models.md index 390d650cb..f3e47d0ce 100644 --- a/docs/readthedocs/models/models.md +++ b/docs/readthedocs/models/models.md @@ -166,6 +166,7 @@ Some models can use additional data for their calculations. --- maxdepth: 1 --- +input/additionaldata/weathersource input/additionaldata/timeseries input/additionaldata/idcoordinatesource ``` From 427a90c2311ca7babecbace30ced5bab78e4935d Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Thu, 24 Jul 2025 12:46:27 +0200 Subject: [PATCH 3/5] switch weathersource in toctree --- docs/readthedocs/models/models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/models/models.md b/docs/readthedocs/models/models.md index f3e47d0ce..0803c7777 100644 --- a/docs/readthedocs/models/models.md +++ b/docs/readthedocs/models/models.md @@ -166,9 +166,9 @@ Some models can use additional data for their calculations. --- maxdepth: 1 --- -input/additionaldata/weathersource input/additionaldata/timeseries input/additionaldata/idcoordinatesource +input/additionaldata/weathersource ``` ## Result From 4f55576210c2578eb826fe0411c122d9b6c65136 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Mon, 28 Jul 2025 11:44:55 +0200 Subject: [PATCH 4/5] Review feedback implemented, weather data subsection added and expanded. --- .../input/additionaldata/weathersource.md | 38 ++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/readthedocs/models/input/additionaldata/weathersource.md b/docs/readthedocs/models/input/additionaldata/weathersource.md index 83a616b73..b06322076 100644 --- a/docs/readthedocs/models/input/additionaldata/weathersource.md +++ b/docs/readthedocs/models/input/additionaldata/weathersource.md @@ -27,4 +27,40 @@ The source data for any `WeatherSource` implementation is expected to contain th - The specific timestamp of the weather data, typically as a `ZonedDateTime`. * - **Weather Data** - - The meteorological values, such as solar irradiance (`direct` and `diffuse`), temperature, and wind data (`speed` and `direction`). \ No newline at end of file + - The meteorological values, such as solar irradiance (`direct` and `diffuse`), temperature, and wind data (`speed` and `direction`). +``` + +## WeatherData + +Weather data is comprised of five key components: + +```{list-table} + :widths: auto + :class: wrapping + :header-rows: 1 + + * - Component + - Description + - Unit + + * - **`directIrradiance`** + - Solar radiation that reaches the surface directly from the sun. + - W/m² + + * - **`diffuseIrradiance`** + - Solar radiation scattered by the atmosphere before reaching the surface. + - W/m² + + * - **`temperature`** + - Ambient air temperature. + - K (Kelvin) + + * - **`windVelocity`** + - Wind speed. + - m/s (meters per second) + + * - **`windDirection`** + - Wind direction, where 0° is North, 90° is East, etc. + - ° (degrees) +``` +Weather data in COSMO and ICON formats is supported. Additional optional weather data can also be provided. \ No newline at end of file From bedb8d4497936768c83097986f329021ca1eb7c7 Mon Sep 17 00:00:00 2001 From: pierrepetersmeier <155652256+pierrepetersmeier@users.noreply.github.com> Date: Mon, 28 Jul 2025 17:28:23 +0200 Subject: [PATCH 5/5] CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cce4d596b..2c04c91a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased/Snapshot] -### Added +### Added +-Added weathersource documentation [#1390](https://github.com/ie3-institute/PowerSystemDataModel/issues/1390) ### Fixed