Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve cgmes documentation: boundary location options #317

Merged
merged 4 commits into from
May 24, 2024
Merged

Improve cgmes documentation: boundary location options #317

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be52cc2
Improve cgmes documentation about options regarding boundary file loc…
colinepiloquet Mar 13, 2024
af0a298
Merge branch 'main' into improve_cgmes_doc
colinepiloquet Apr 10, 2024
1475eb6
Merge branch 'main' into improve_cgmes_doc
annetill Apr 25, 2024
a84fc0b
Merge branch 'main' into improve_cgmes_doc
annetill May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion pages/documentation/grid/formats/cim-cgmes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,7 @@ These properties can be defined in the configuration file in the [import-export-

**iidm.import.cgmes.boundary-location**
Optional property that defines the directory path where the CGMES importer can find the boundary files (`EQBD` and `TPBD` profiles) if they are not present in the imported zip file. By default, its value is `<ITOOLS_CONFIG_DIR>/CGMES/boundary`.
This property can also be used at CGMES export if the network was not imported from a CGMES to indicate the boundary files that should be used for reference.

**iidm.import.cgmes.convert-boundary**
Optional property that defines if the equipment located inside the boundary are imported as part of the network. Used for debugging purposes. `false` by default.
Expand Down Expand Up @@ -668,11 +669,13 @@ By default, the base name is the network's name if it exists, or else the networ

**iidm.export.cgmes.boundary-eq-id**
Optional property that defines the ID of the EQ-BD model if there is any.
Its default value is `null`: we consider there is no EQ-BD model to consider.
Its default value is `null`: we consider there is no EQ-BD model to consider.
If this property is defined, then this ID will be written in the header of the exported EQ file.

**iidm.export.cgmes.boundary-tp-id**
Optional property that defines the ID of the TP-BD model if there is any.
Its default value is `null`: we consider there is no TP-BD model to consider.
If this property is defined, then this ID will be written in the header of the exported SV file.

**iidm.export.cgmes.cim-version**
Optional property that defines the CIM version number in which the user wants the CGMES files to be exported.
Expand Down Expand Up @@ -751,6 +754,9 @@ Its default value is 1.
The business process in which the export takes place. This is used to generate unique UUIDs for the EQ, TP, SSH and SV file `FullModel`.
Its default value is `1D`.


Note that if you are exporting a network that does not come from CGMES, you can use the [`iidm.import.cgmes.boundary-location`](#options) property to define the location of the boundary files to use as reference.

## Examples
Have a look to the [CGMES sample files](https://www.entsoe.eu/Documents/CIM_documents/Grid_Model_CIM/TestConfigurations_packageCASv2.0.zip)
from ENTSO-E Test Configurations for Conformity Assessment Scheme v2.0.