From c5b2ea54beec2e2ae0f02714fab5b49a41f6064a Mon Sep 17 00:00:00 2001 From: Markus Mirz Date: Wed, 1 Jun 2022 10:13:28 +0200 Subject: [PATCH] add explanation of inputs and outputs Signed-off-by: Markus Mirz --- docs/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9a7ec3c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,22 @@ +# Documentation + +A good place to start is the examples/quickstart/ folder of the repo. + +## Inputs + +Basically, pyvolt requires to kinds of data: +- grid topology +- measurements or load flow results +- uncertainty values for measurements + +The grid data can be imported from CIM / CGMES XML files (e.g. examples/sample_data/CIGRE-MV-NoTap/*.xml). +cimpy is used for the import of grid data. + +Measurement values can be read from a CSV file (e.g. examples/sample_data/CIGRE-MV-NoTap/*.csv). + +Uncertainties are specified per measurement type. The measurement types are defined in: pyvolt/measurement.py -> class MeasType + +## Outputs + +The state estimation returns a Results object (pyvolt/results.py). +While voltages are available upon completion of the state estimation, other variables like currents and power can be calculated on demand if required. \ No newline at end of file