goblin_lite.data_processing.forest_carbon_generator

This module contains the ForestCarbonGenerator class, which is responsible for generating forest carbon data. The class leverages the Runner class to calculate forest carbon data based on scenario-specific and baseline forest data.

Module Contents

Classes

ForestCarbonGenerator

Manages the process of generating forest carbon data, leveraging the CBM

class goblin_lite.data_processing.forest_carbon_generator.ForestCarbonGenerator(goblin_data_manager, scenario_dataframe, afforestation_dataframe)

Manages the process of generating forest carbon data, leveraging the CBM Runner class (from the cbm_runner module) to perform the core carbon calculations.

goblin_data_manager_class

An instance of the data manager class used to retrieve configuration and database paths.

Type:

object

calibration_year

The base year used for calibrating the carbon model.

Type:

int

cbm_config_path

The path to the configuration file for the CBM.

Type:

str

DATABASE_PATH

The path to the database used by the CBM.

Type:

str

sit_path

The path to the SIT directory.

Type:

str, optional

cbm_runner_data_manager

An instance of the DataManager class used to manage CBM runner data.

Type:

DataManager

generate_forest_carbon()

Generates forest carbon data using the provided input data.

generate_forest_carbon()

Generates forest carbon data using the provided input data.

Returns:

A dictionary containing forest carbon data with keys ‘forest_flux’, ‘forest_aggregate’, and ‘afforestation_area’.

Return type:

dict