Skip to content

Commit b45f581

Browse files
add weathersource docs
1 parent ad22242 commit b45f581

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# WeatherSource
2+
3+
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).
4+
5+
A `WeatherSource` relies on two key components:
6+
* **[`IdCoordinateSource`](/additionaldata/idcoordinatesource)**: Used to resolve a numeric **coordinate ID** from the source data into a geographic `Point` object.
7+
* **`TimeBasedWeatherValueFactory`**: Used to construct `WeatherValue` objects from the raw data fields.
8+
9+
***
10+
11+
## Information
12+
13+
The source data for any `WeatherSource` implementation is expected to contain the following information.
14+
15+
```{list-table}
16+
:widths: auto
17+
:class: wrapping
18+
:header-rows: 1
19+
20+
* - Attribute
21+
- Remarks
22+
23+
* - **`coordinateid`**
24+
- An **integer ID** for a specific geographic coordinate. This ID is used to look up the actual `Point` via the `IdCoordinateSource`.
25+
26+
* - **Time**
27+
- The specific timestamp of the weather data, typically as a `ZonedDateTime`.
28+
29+
* - **Weather Data**
30+
- The meteorological values, such as solar irradiance (`direct` and `diffuse`), temperature, and wind data (`speed` and `direction`).

0 commit comments

Comments
 (0)