CIMD
Command Line Interface
Warning
cimd is alpha software. Using cimd today means participating in its development.
cimd eq
$ cimd eq --help
Usage: cimd eq <subcommand> <file> [options]
Operate on a CGMES EQ (Equipment) profile.
Subcommands:
convert Convert EQ profile to JIIDM JSON
browse Interactively browse equipment objects
get Fetch a single object by mRID (JSON output)
types List all CIM types present in the file
Use 'cimd eq <subcommand> --help' for more information.
convert
$ cimd eq convert --help
Usage: cimd eq convert <file> [options]
Convert a CGMES EQ profile to JIIDM JSON format.
Output is written to stdout unless --output is given.
Arguments:
<file> EQ profile (XML or ZIP)
Options:
--eqbd <file> EQBD boundary profile (XML or ZIP)
--output <file> Write output to file instead of stdout
Examples:
cimd eq convert data/eq.zip
cimd eq convert data/eq.zip --eqbd eqbd.zip
cimd eq convert data/eq.zip --output network.json
browse
$ cimd eq browse --help
Usage: cimd eq browse <file> <mrid> [options]
Interactively browse equipment objects by following rdf:resource references.
Arguments:
<file> EQ profile (XML or ZIP)
<mrid> mRID of the object to start browsing from
Options:
--eqbd <file> EQBD boundary profile (XML or ZIP)
Examples:
cimd eq browse data/eq.zip _be60a3cf-fed6-d11c-c15f-42ac6cc4e221
get
$ cimd eq get --help
Usage: cimd eq get <file> [<mrid>] [options]
Fetch a CIM object by mRID, or list all objects of a given type.
At least one of <mrid> or --type must be provided.
Exits 0 on success, 1 if the mRID is not found.
Arguments:
<file> EQ profile (XML or ZIP)
<mrid> mRID of the object to fetch (optional if --type is given)
Options:
--eqbd <file> EQBD boundary profile (XML or ZIP)
--type <type> Filter by CIM type (e.g. PowerTransformer)
Without <mrid>: list all objects of this type
With <mrid>: verify the object is of this type
--fields <f1,f2,...> Properties to include in list output (list mode only)
Default: IdentifiedObject.name
--count Print only the count of matching objects (list mode only)
--json Output as JSON
Examples:
cimd eq get data/eq.zip _be60a3cf-fed6-d11c-c15f-42ac6cc4e221
cimd eq get data/eq.zip _be60a3cf-fed6-d11c-c15f-42ac6cc4e221 --json
cimd eq get data/eq.zip _be60a3cf-fed6-d11c-c15f-42ac6cc4e221 --type PowerTransformer
cimd eq get data/eq.zip --type PowerTransformer --json
cimd eq get data/eq.zip --type PowerTransformer --count
cimd eq get data/eq.zip --type VoltageLevel --fields IdentifiedObject.name,VoltageLevel.nominalVoltage
types
$ cimd eq types --help
Usage: cimd eq types <file> [options]
List all CIM types present in the EQ profile with object counts.
Arguments:
<file> EQ profile (XML or ZIP)
Options:
--eqbd <file> EQBD boundary profile (XML or ZIP)
--json Output as JSON array of {type, count} objects
Examples:
cimd eq types data/eq.zip
cimd eq types data/eq.zip --json