hestia_earth.calculation.emission_hierarchies.Emissions_hierarchy

class hestia_earth.calculation.emission_hierarchies.Emissions_hierarchy

Bases: hestia_earth.calculation.abstract_hierarchy.Hierarchy

Model_Hierarchy class. This is an abstract class from which inherit all the hierarchies defined in Hestia. It contains a set of common methods and instance variables that are typically used by every hierarchy. A hierarchy defines the order to run the calculations in the models for a particular emission defined in Hestia. The order is from higher tier to lower tier.

Methods

build_emission
calculate_model
check_model
get_reference
process_hierarchy	Method that procesess the hierarchy through all the models for a given cycle. It is overwritten in for different kind of engines Arguments: cycle: This is a cycle in the representation required by the engine. (Different from the Schema representation) Returns a file object.
round_to_significant	Method to round to a given number of significant numbers.
update_node	Method that updates cycle representation emission.
update_representation	Method that checks if the model has enough data to do the calculation.

Attributes

context

process_hierarchy(cycle)

Method that procesess the hierarchy through all the models for a given cycle. It is overwritten in for different kind of engines

Arguments:

cycle: This is a cycle in the representation required by the engine. (Different from the Schema representation)

Returns a file object.

round_to_significant(number, sig_number)

Method to round to a given number of significant numbers. :param number: The number to round. :param sig_number: The number of significant numbers.

Returns The rounded number.

update_node(data)

Method that updates cycle representation emission. :param data: It is a dataStore object with the representation with the emission to be updated

Returns boolean.

update_representation(cycle)

Method that checks if the model has enough data to do the calculation. :param cycle: This is a cycle in the representation required by the calculation engine. :param (Different from the Schema representation):

Returns boolean.