Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Rätz committed Nov 26, 2024
1 parent 655a245 commit 1234a63
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Joss_Paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ formatted weather data by providing a streamlined process.
*Data conversion*: AixWeather converts this raw weather data from various sources into a defined core format and, from there, into the desired export format.

*Data accuracy*: AixWeather ensures data accuracy by taking into account critical factors that are
often overlooked in custom solutions, including consideration of time zones,
often overlooked in custom solutions, which are specifically the consideration of time zones,
the time reference of the measurement, unit conversions, correct handling of incomplete data series
and, where possible, the avoidance of interpolation-related smoothing.

Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ For background knowledge, check the below tool structure and overview.

## Tool structure and overview

**This tool consists of three layers:**
AixWeather is a tool for generating weather data for building energy system simulations.
It retrieves, formats, enriches, and ultimately exports weather data in various file formats.

**This tool consists of three layers that are executed as a pipeline for each run:**

1. Import raw weather data from several sources

Expand All @@ -66,8 +69,17 @@ For background knowledge, check the below tool structure and overview.

3. Transform the core-format data to your desired output format

Which transformations are executed, i.e. required, will always depend on the input data and the
desired output format.
The current set of implemented transformation functions can be found in
[aixweather/transformation_functions](aixweather/transformation_functions).
The tool selects the required transformation functions based on the input data and
the desired output format.

**Overview**

The below diagram shows the tool's structure and the data flow from the import to the output format.

![Weather Data Tool Diagram](docs/Overview_WeatherTool.png)

**Known limitations:**
Expand Down

0 comments on commit 1234a63

Please sign in to comment.