Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
66 changes: 66 additions & 0 deletions docs/readthedocs/models/input/additionaldata/weathersource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# 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`](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.

***

## 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`).
```

## 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.
1 change: 1 addition & 0 deletions docs/readthedocs/models/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ maxdepth: 1
---
input/additionaldata/timeseries
input/additionaldata/idcoordinatesource
input/additionaldata/weathersource
```

## Result
Expand Down