Executable timeseries chronics #138
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,33 @@ | ||||||
| --- | ||||||
| sidebar_position: 3 | ||||||
| --- | ||||||
|
|
||||||
| # villas chronics | ||||||
|
|
||||||
| The `villas chronics` command is a tool that can be used to process CSV files containing load and generator data to create chronics files for input in power grid simulations using [Grid2op](https://grid2op.readthedocs.io/en/stable/user/chronics.html). | ||||||
| It reads normalized active and reactive power values from `Load` and `SGen` CSV files, maps them to buses given through a grid configuration json file and outputs formatted CSV files (optionally compressed in bz2 format). | ||||||
|
|
||||||
| # Usage | ||||||
| In command line, you run: `villas-chronics config.json` | ||||||
|
|
||||||
| ``` url="generated/node/usage/villas-signal.txt" title="villas-chronics --help" | ||||||
| Usage: villas-chronics config.json | ||||||
| config.json can be as shown below: | ||||||
|
|
||||||
| { | ||||||
| "loads_dir": "/workspaces/node-main/input_files", | ||||||
| "sgens_dir": "/workspaces/node-main/input_files", | ||||||
| "grid": "/workspaces/node-main/input_files/grid_file.json", | ||||||
| "output": "/workspaces/node-main/output_files", | ||||||
| "compress": true | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ## Docker | ||||||
| ``` | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. I would also prefer to simply show the |
||||||
| docker run --rm --entrypoint villas-chronics \ | ||||||
| -v "$PWD:/workspaces/node-main" \ | ||||||
| -w /workspaces/node-main \ | ||||||
| registry.git.rwth-aachen.de/acs/public/villas/node:executable-timeseries-chronics-x86_64 \ | ||||||
| -d info /workspaces/node-main/input_files/chronics.json | ||||||
| ``` | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please note that this codeblock gets completely overwritten by the scripts in https://github.com/VILLASframework/documentation/tree/master/tools