diff --git a/CHANGELOG.md b/CHANGELOG.md index 701bb86ea4..44290c1dd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add some quote to 'printGoodbye' [#997](https://github.com/ie3-institute/simona/issues/997) - Add unapply method for ThermalHouseResults [#934](https://github.com/ie3-institute/simona/issues/934) - Added `ApparentPower` to differentiate between different power types [#794](https://github.com/ie3-institute/simona/issues/794) +- Update/enhance config documentation [#1013](https://github.com/ie3-institute/simona/issues/1013) ### Changed - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435) diff --git a/docs/readthedocs/config.md b/docs/readthedocs/config.md index 45deee0778..f6e968659a 100644 --- a/docs/readthedocs/config.md +++ b/docs/readthedocs/config.md @@ -12,15 +12,13 @@ To create the output directory name, the name of the simulation is used as a str `simona.simulationName = "vn_simona"` ### Time parameters -Starting date and time of the simulation - - Format: "YYYY-MM-DD HH:MM:SS" +Starting date and time of the simulation in ISO-8601 date and time format with offset - `simona.time.startDateTime = "2011-01-01 00:00:00"` + `simona.time.startDateTime = "2011-01-01T00:00:00Z"` -Ending date and time of the simulation - - Format: "YYYY-MM-DD HH:MM:SS" +Ending date and time of the simulation in ISO-8601 date and time format with offset - `simona.time.endDateTime = "2011-01-01 02:00:00"` + `simona.time.endDateTime = "2011-01-01T02:00:00Z"` The preset ReadyCheckWindow should be maintained @@ -39,7 +37,9 @@ Setting of the data source `simona.input.grid.datasource.id = "csv"` -Specify the folder path containing the csv data of the grid components and the csv separator (e.g. "," or ";") +Specify the folder path containing the csv data of the grid components and the csv separator (e.g. "," or ";"). +The directory structure is determined by the boolean `isHierarchic`. +If files are placed within [a specific set of subdirectories](https://powersystemdatamodel.readthedocs.io/en/latest/io/csvfiles.html#default-directory-hierarchy), `isHierarchic: true` needs to be set. ``` simona.input.primary.csvParams = {