From 787f53d5fa3c0bfa8ad9f4d6b95a293a8bbabd53 Mon Sep 17 00:00:00 2001 From: "Ritesh.K" Date: Thu, 16 Apr 2026 11:32:31 +0200 Subject: [PATCH 1/2] feat (villas-chronics): Add documentation for villas-chronics executable Signed-off-by: Ritesh.K --- docs/node/usage/index.md | 1 + docs/node/usage/villas-chronics.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/node/usage/villas-chronics.md 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..d463582a --- /dev/null +++ b/docs/node/usage/villas-chronics.md @@ -0,0 +1,23 @@ +--- +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 power grid simulations while using OpenDSS. +It reads normalized active and reactive power values from `Load` and `SGen` CSV files, maps them to buses given through a grid configuration file and outputs formatted CSV files (optionally compressed in bz2 format). + +# Usage + +``` 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, +} +``` From d40b3e29e578cef6ffb5da0d4adf8acdc3f81ced Mon Sep 17 00:00:00 2001 From: Alexandra Date: Tue, 21 Apr 2026 07:36:28 +0000 Subject: [PATCH 2/2] add (executable-chronics): docker command and link Signed-off-by: Alexandra --- docs/node/usage/villas-chronics.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/node/usage/villas-chronics.md b/docs/node/usage/villas-chronics.md index d463582a..ef37260c 100644 --- a/docs/node/usage/villas-chronics.md +++ b/docs/node/usage/villas-chronics.md @@ -4,10 +4,11 @@ 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 power grid simulations while using OpenDSS. -It reads normalized active and reactive power values from `Load` and `SGen` CSV files, maps them to buses given through a grid configuration file and outputs formatted CSV files (optionally compressed in bz2 format). +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 @@ -18,6 +19,15 @@ Usage: villas-chronics config.json "sgens_dir": "/workspaces/node-main/input_files", "grid": "/workspaces/node-main/input_files/grid_file.json", "output": "/workspaces/node-main/output_files", - "compress": true, + "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 +```