Parameter

In openLCA, parameters can be defined in different scopes: global, process, or LCIA method. The parameter name can be used in formulas and, thus, need to conform to a specific syntax. Within a scope the parameter name should be unique (otherwise the evaluation is not deterministic). There are two types of parameters in openLCA: input parameters and dependent parameters. An input parameter can have an optional uncertainty distribution but not a formula. A dependent parameter can (should) have a formula (where also other parameters can be used) but no uncertainty distribution.

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

`formula`

A mathematical expression to calculate the parameter value.

Type: string (external doc)
Proto-Index: 10

`isInputParameter`

Indicates whether the parameter is an input parameter (true) or a dependent/calculated parameter (false). A parameter can have a formula if it is not an input parameter.

Type: boolean (external doc)
Proto-Index: 11

`parameterScope`

The scope where the parameter is valid.

Type: ParameterScope
Proto-Index: 12

`uncertainty`

An uncertainty distribution of the parameter value. This is only valid for input parameters.

Type: Uncertainty
Proto-Index: 13

`value`

The parameter value.

Type: double (external doc)
Proto-Index: 14

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 Parameter:
  id: str
  category: str
  description: str
  formula: str
  is_input_parameter: bool
  last_change: str
  library: str
  name: str
  parameter_scope: ParameterScope
  tags: List[str]
  uncertainty: Uncertainty
  value: float
  version: str

openLCA schema