Voltage Source Equipment

pydantic model gdm.distribution.equipment.PhaseVoltageSourceEquipment

Data model for phase voltage source.

Show JSON schema

{
   "title": "PhaseVoltageSourceEquipment",
   "description": "Data model for phase voltage source.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "r0": {
         "default": "OVERHEAD",
         "description": "Zero sequence resistance.",
         "title": "R0",
         "type": "string"
      },
      "r1": {
         "default": "OVERHEAD",
         "description": "Positive sequence resistance.",
         "title": "R1",
         "type": "string"
      },
      "x0": {
         "default": "OVERHEAD",
         "description": "Zero sequence reactance.",
         "title": "X0",
         "type": "string"
      },
      "x1": {
         "default": "OVERHEAD",
         "description": "Positive sequence reactane.",
         "title": "X1",
         "type": "string"
      },
      "voltage": {
         "default": "OVERHEAD",
         "description": "Voltage for this substation.",
         "title": "Voltage",
         "type": "string"
      },
      "voltage_type": {
         "$ref": "#/$defs/VoltageTypes",
         "default": [
            "line-to-line"
         ]
      },
      "angle": {
         "default": "OVERHEAD",
         "description": "Angle for the voltage",
         "title": "Angle",
         "type": "string"
      }
   },
   "$defs": {
      "VoltageTypes": {
         "description": "Identifier of voltage types referenced in distribution models.",
         "enum": [
            "line-to-line",
            "line-to-ground"
         ],
         "title": "VoltageTypes",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "r0",
      "r1",
      "x0",
      "x1",
      "voltage",
      "angle"
   ]
}

Config:

• str_strip_whitespace: bool = True

• validate_assignment: bool = True

• validate_default: bool = True

• extra: str = forbid

• use_enum_values: bool = False

• arbitrary_types_allowed: bool = True

• populate_by_name: bool = True

Fields:

• angle (infrasys.quantities.Angle)

• name (str)

• r0 (infrasys.quantities.Resistance)

• r1 (infrasys.quantities.Resistance)

• uuid (uuid.UUID)

• voltage (infrasys.quantities.Voltage)

• voltage_type (gdm.distribution.enums.VoltageTypes)

• x0 (gdm.quantities.Reactance)

• x1 (gdm.quantities.Reactance)

field angle: WithJsonSchema(json_schema={'type': 'string', 'default': 'OVERHEAD'}, mode=None), FieldInfo(annotation=NoneType, required=True, description='Angle for the voltage')] [Required]

Angle for the voltage

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

field r0: ')] [Required]

Zero sequence resistance.

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

field r1: ')] [Required]

Positive sequence resistance.

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

field voltage: ', metadata=[Gt(gt=0)])] [Required]

Voltage for this substation.

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

• gt = 0

field voltage_type: VoltageTypes = (VoltageTypes.LINE_TO_LINE,)

field x0: ')] [Required]

Zero sequence reactance.

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

field x1: ')] [Required]

Positive sequence reactane.

Constraints:

• json_schema = {‘type’: ‘string’, ‘default’: ‘OVERHEAD’}

pydantic model gdm.distribution.equipment.VoltageSourceEquipment

Data model for voltage source model.

Show JSON schema

{
   "title": "VoltageSourceEquipment",
   "description": "Data model for voltage source model.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "sources": {
         "description": "list of single phase voltage sources",
         "items": {
            "$ref": "#/$defs/PhaseVoltageSourceEquipment"
         },
         "title": "Sources",
         "type": "array"
      }
   },
   "$defs": {
      "PhaseVoltageSourceEquipment": {
         "additionalProperties": false,
         "description": "Data model for phase voltage source.",
         "properties": {
            "uuid": {
               "format": "uuid",
               "title": "Uuid",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "r0": {
               "default": "OVERHEAD",
               "description": "Zero sequence resistance.",
               "title": "R0",
               "type": "string"
            },
            "r1": {
               "default": "OVERHEAD",
               "description": "Positive sequence resistance.",
               "title": "R1",
               "type": "string"
            },
            "x0": {
               "default": "OVERHEAD",
               "description": "Zero sequence reactance.",
               "title": "X0",
               "type": "string"
            },
            "x1": {
               "default": "OVERHEAD",
               "description": "Positive sequence reactane.",
               "title": "X1",
               "type": "string"
            },
            "voltage": {
               "default": "OVERHEAD",
               "description": "Voltage for this substation.",
               "title": "Voltage",
               "type": "string"
            },
            "voltage_type": {
               "$ref": "#/$defs/VoltageTypes",
               "default": [
                  "line-to-line"
               ]
            },
            "angle": {
               "default": "OVERHEAD",
               "description": "Angle for the voltage",
               "title": "Angle",
               "type": "string"
            }
         },
         "required": [
            "name",
            "r0",
            "r1",
            "x0",
            "x1",
            "voltage",
            "angle"
         ],
         "title": "PhaseVoltageSourceEquipment",
         "type": "object"
      },
      "VoltageTypes": {
         "description": "Identifier of voltage types referenced in distribution models.",
         "enum": [
            "line-to-line",
            "line-to-ground"
         ],
         "title": "VoltageTypes",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "sources"
   ]
}

Config:

• str_strip_whitespace: bool = True

• validate_assignment: bool = True

• validate_default: bool = True

• extra: str = forbid

• use_enum_values: bool = False

• arbitrary_types_allowed: bool = True

• populate_by_name: bool = True

Fields:

• name (str)

• sources (list[gdm.distribution.equipment.phase_voltagesource_equipment.PhaseVoltageSourceEquipment])

• uuid (uuid.UUID)

field sources: Annotated[list[PhaseVoltageSourceEquipment], FieldInfo(annotation=NoneType, required=True, description='list of single phase voltage sources')] [Required]

list of single phase voltage sources