archetypal.template.StructureInformation

class archetypal.template.StructureInformation(Name, MassRatios, **kwargs)

Building Structure settings.

Initialize object.

Parameters

• MassRatios (list of MassRatio) – MassRatio object.

• **kwargs – keywords passed to the ConstructionBase constructor.

property MassRatios

Get or set the list of MassRatios.

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 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 DisassemblyCarbon

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

property DisassemblyEnergy

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

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.

classmethod from_dict(data, materials, **kwargs)

Create StructureInformation from a dictionary.

Parameters

• data (dict) – A python dictionary.

• materials (dict) – A dictionary of python OpaqueMaterials with their id as keys.

• **kwargs – keywords passed to parent constructors.

get_unique()

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

property id

Get or set the id.

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_ref()

Return a ref pointer to self.

to_dict()

Return StructureInformation dictionary representation.

validate()

Validate object and fill in missing values.

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.

duplicate()

Get copy of self.