archetypal.template.constructions.base_construction.ConstructionBase

class archetypal.template.constructions.base_construction.ConstructionBase(Name, AssemblyCarbon=0, AssemblyCost=0, AssemblyEnergy=0, DisassemblyCarbon=0, DisassemblyEnergy=0, **kwargs)[source]

A class used to store data linked to Life Cycle aspects.

For more information on the Life Cycle Analysis performed in UMI, see: https://umidocs.readthedocs.io/en/latest/docs/life-cycle-introduction.html#life-cycle-impact

Initialize a ConstructionBase object with parameters.

Parameters

  • AssemblyCarbon (float) – assembly carbon [kgCO2/m2].

  • AssemblyCost (float) – assembly carbon [kgCO2/m2].

  • AssemblyEnergy (float) – assembly energy [MJ/m2].

  • DisassemblyCarbon (float) – disassembly carbon [kgCO2/m2].

  • DisassemblyEnergy (float) – disassembly energy [MJ/m2].

  • **kwargs – keywords passed to UmiBase.

property AssemblyCarbon

Get or set the assembly carbon [kgCO2/m2].

property AssemblyCost

Get or set the assembly cost [$/m2].

property AssemblyEnergy

Get or set the assembly energy [MJ/m2].

property DisassemblyCarbon

Get or set the disassembly carbon [kgCO2/m2].

property DisassemblyEnergy

Get or set the disassembly energy [MJ/m2].

validate()[source]

Validate object and fill in missing values.

duplicate()[source]

Get copy of self.

property Category

Get or set the Category attribute.

property Comments

Get or set the object comments.

property DataSource

Get or set the datasource of the object.

property Name

Get or set the name of the object.

property allow_duplicates

Get or set the use of duplicates [bool].

extend(other, allow_duplicates)

Append other to self. Modify and return self.

Parameters

other (UmiBase) –

Returns

self

Return type

UmiBase

float_mean(other, attr, weights=None)

Calculates the average attribute value of two floats. Can provide weights.

Parameters

  • other (UmiBase) – The other UmiBase object to calculate average value with.

  • attr (str) – The attribute of the UmiBase object.

  • weights (iterable, optional) – Weights of [self, other] to calculate weighted average.

get_unique()

Return first object matching equality in the list of instantiated objects.

property id

Get or set the id.

mapping(validate=True)

Get a dict based on the object properties, useful for dict repr.

Parameters

validate (bool) – If True, try to validate object before returning the mapping.

property predecessors

Get or set the predecessors of self.

Of which objects is self made of. If from nothing else then self, return self.

rename(name)

renames self as well as the cached object

Parameters

name (str) – the name.

to_dict()

Return UmiBase dictionary representation.

to_ref()

Return a ref pointer to self.