UnitGroup

A group of units that can be converted into each other.

Properties

@type

Inherited from Entity.@type

• Type: string (external doc)
• Proto-Index: 1

@id

Inherited from RefEntity.@id

• Type: string (external doc)
• Proto-Index: 2

name

Inherited from RefEntity.name

• Type: string (external doc)
• Proto-Index: 3

description

Inherited from RefEntity.description

• Type: string (external doc)
• Proto-Index: 4

category

Inherited from RootEntity.category

• Type: string (external doc)
• Proto-Index: 5

lastChange

Inherited from RootEntity.lastChange

• Type: dateTime (external doc)
• Proto-Index: 6

tags

Inherited from RootEntity.tags

• Type: List of string (external doc)
• Proto-Index: 7

version

Inherited from RootEntity.version

• Type: string (external doc)
• Proto-Index: 8

library

Inherited from RootEntity.library

• Type: string (external doc)
• Proto-Index: 9

defaultFlowProperty

Some LCA data formats do not have the concept of flow properties or quantities. This field provides a default link to a flow property for units that are contained in this group.

• Type: Ref of FlowProperty
• Proto-Index: 10

units

The units of the unit group.

• Type: List of Unit
• Proto-Index: 11

Python class stub

The snippet below shows the names of the properties of the corresponding Python class of the olca-schema package. Note that this is not the full class definition but just shows the names of the class and its properties.

@dataclass
class UnitGroup:
  id: str
  category: str
  default_flow_property: Ref
  description: str
  last_change: str
  library: str
  name: str
  tags: List[str]
  units: List[Unit]
  version: str

JSON example

{
  "@type": "UnitGroup",
  "@id": "93a60a57-a3c8-11da-a746-0800200c9a66",
  "name": "Units of energy",
  "category": "Technical unit groups",
  "defaultFlowProperty": {
    "@type": "FlowProperty",
    "@id": "f6811440-ee37-11de-8a39-0800200c9a66",
    "name": "Energy"
  },
  "units": [
    {
      "@type": "Unit",
      "@id": "52765a6c-3896-43c2-b2f4-c679acf13efe",
      "name": "MJ",
      "description": "Megajoule",
      "isRefUnit": true,
      "conversionFactor": 1.0
    },
    {
      "@type": "Unit",
      "@id": "86ad2244-1f0e-4912-af53-7865283103e4",
      "name": "kWh",
      "description": "Kilowatt times hour",
      "conversionFactor": 3.6
    }
  ]
}