diff --git a/docs/node/usage/index.md b/docs/node/usage/index.md index b01d47d6..914b3878 100644 --- a/docs/node/usage/index.md +++ b/docs/node/usage/index.md @@ -32,3 +32,4 @@ For detailed documentation, please see: 'villas node' - [`villas test`](villas-test.md) - [`villas zmq-keygen`](villas-zmq-keygen.md) - [`villas conf2json`](villas-conf2json.md) +- [`villas chronics`](villas-chronics.md) diff --git a/docs/node/usage/villas-chronics.md b/docs/node/usage/villas-chronics.md new file mode 100644 index 00000000..ef37260c --- /dev/null +++ b/docs/node/usage/villas-chronics.md @@ -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 +``` + 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 +```