Skip to content

Commit

Permalink
fix line breaking
Browse files Browse the repository at this point in the history
Signed-off-by: Robin Klaassen <robin.klaassen@alliander.com>
  • Loading branch information
robinklaassen committed Oct 9, 2023
1 parent 4384d02 commit 0bf3c74
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ Python dataclasses for CGMES 3 + RDF schema description + SHACL (validation) fil

The Common Grid Model Exchange Specification, or CGMES, is provided by ENTSO-E (the European Network of TSOs for
Electricity) to facilitate the exchange of grid data between parties. It is based on CIM, the Common Information Model
for electric utilities, provided by the
IEC (see also [CIM on Wikipedia](https://en.wikipedia.org/wiki/Common_Information_Model_(electricity))).
for electric utilities, provided by the IEC (see also
[CIM on Wikipedia](https://en.wikipedia.org/wiki/Common_Information_Model_(electricity))).

CIM defines the vocabulary for electricity grids, meaning the names we use for different components and the way they
relate to each other. CGMES takes a subset of this vocabulary and provides RDF schema and SHACL validation files.

Further reading and all relevant CGMES (source) files are found
on [the CGMES page of the ENTSO-E website](https://www.entsoe.eu/data/cim/cim-for-grid-models-exchange/).
Further reading and all relevant CGMES (source) files are found on
[the CGMES page of the ENTSO-E website](https://www.entsoe.eu/data/cim/cim-for-grid-models-exchange/).

## Library usage

Expand All @@ -56,10 +56,8 @@ If this is a leaf node (for instance `ACLineSegment`), it "just works". If you w
class higher in the hierarchy (for instance `Equipment`) there is a lot more work to do.

By default, an attribute is fully qualified. `bch` in `ACLineSegment` will appear as `ACLineSegment.bch` in the
serialisation.
For a custom attribute, you might not want to see `ACLineSegmentCustom.bch`. To prevent this, you can override
the `apparent_name`
of your custom class:
serialisation. For a custom attribute, you might not want to see `ACLineSegmentCustom.bch`. To prevent this, you can
override the `apparent_name` of your custom class:

```python
from pydantic.dataclasses import dataclass
Expand All @@ -78,8 +76,7 @@ class ACLineSegmentCustom(ACLineSegment):
### Namespace

In the serialisation, the namespace of all attributes is `cim` (`"http://iec.ch/TC57/2013/CIM-schema-cim16#"`) by
default.
The serialisation is not done by PyCGMES (yet), but if you want a custom namespace for an attribute,
default. The serialisation is not done by PyCGMES (yet), but if you want a custom namespace for an attribute,
you can give a hint to the serialiser by adding some metadata to your custom attributes:

```python
Expand Down

0 comments on commit 0bf3c74

Please sign in to comment.