goblin_lite.goblin
The Goblin Lite module is designed for running environmental impact scenarios, focusing on agricultural practices and land use. It is intended to be used in the context of environmental impact assessments, and it generates a series of data tables representing various aspects of environmental impact under different agricultural and land use scenarios.
These tables are stored and can be accessed for further analysis and visualization.
Module Contents
Classes
The ScenarioRunner class is responsible for orchestrating the entire scenario generation process in the context |
- class goblin_lite.goblin.ScenarioRunner(ef_country, calibration_year, target_year, config_path, cbm_config_path, DATABASE_PATH=None, AR_VALUE='AR5')[source]
The ScenarioRunner class is responsible for orchestrating the entire scenario generation process in the context of environmental impact assessments, focusing on agricultural practices and land use scenarios.
Args:
- ef_countrystr
The country for which the scenario is being run.
- calibration_yearint
The year for calibration data.
- target_yearint
The target year for which the scenario is generated.
- config_pathstr
The path to the scenario configuration file.
- cbm_config_pathstr
The path to the CBM CFS3 configuration file.
- DATABASE_PATHstr, optional
The path to the database. Default is None.
- AR_VALUEstr, optional
The Assessment Report value. Default is “AR5”.
- ef_country
The country for which the scenario is being run.
- Type:
str
- calibration_year
The year for calibration data.
- Type:
int
- target_year
The target year for which the scenario is generated.
- Type:
int
- config_path
The path to the scenario configuration file.
- Type:
str
- cbm_config_path
The path to the CBM CFS3 configuration file.
- Type:
str
- DATABASE_PATH
The path to the database. Default is None.
- Type:
str, optional
- AR_VALUE
The Assessment Report value. Default is “AR5”.
- Type:
str, optional
- data_manager_class
An instance of the DataManager class for managing data storage.
- Type:
- run_scenarios()[source]
Orchestrates the scenario generation process, encompassing data preparation, analysis, and storage. It generates a series of data tables representing various aspects of environmental impact under different agricultural and land use scenarios. These tables are stored and can be accessed for further analysis and visualization.
- Note:
- -----
An external database is required for the CBM validation process. If CBM validation is enabled, the DATABASE_PATH must be provided.
- run_scenarios()[source]
Executes the scenario generation process using provided inputs and configurations.
This method manages the complete scenario generation process. It prepares and generates data for various scenarios and the selected baseline across multiple domains (such as animal data, land use, crop data, carbon flux, etc.), encapsulated in 31 distinct data tables. These tables are saved as pandas dataframes and are intended for subsequent analysis and visualization.