Skip to main content

An interface between the CBM CFS3, libcbm_py, model and the GOBLIN model.

Project description

🌲 GOBLIN_CBM_runner, a CBM CFS3 interface for the GOBLIN model

license python Code style: black

Based on the GOBLIN (General Overview for a Backcasting approach of Livestock INtensification) LifeCycle Analysis tool, the cbm_runner package generates the data requried for the CBM CFS3 (libcbm_py) tool. It also interfaces with the tool directly, generating results in a single dataframe for all scenarios.

The outputs are related to biomass, and dead organic matter. These are summed into a total ecosystem value.

The estimated volumns are all in t of C.

Installation

Install from git hub.

pip install "goblin_cbm_runner@git+https://github.com/GOBLIN-Proj/goblin_cbm_runner.git@main" 

Install from PyPI

pip install goblin_cbm_runner

Usage

The Runner class takes the total afforestation area and divides it evenly across years (calibration year - target year).

from goblin_cbm_runner.default_runner.runner import Runner
import pandas as pd
import os


def main():
    # path to data
    path = "./data/runner_input"
    results_path = "./data/runner_results"

    # afforestation data for each scenario
    afforest_data = pd.read_csv(
        os.path.join(path, "cbm_afforestation.csv"), index_col=0
    )

    # basic configuration file
    config = os.path.join(path, "cbm_factory.yaml")

    # scenario_data
    sc_data = pd.read_csv(os.path.join(path, "scenario_dataframe.csv"))

    # calibration and end point
    calibration_year = 2020

    # instance of the Runner class
    runner = Runner(config, calibration_year, afforest_data, sc_data)

    # generation of aggregated results
    runner.run_aggregate_scenarios().to_csv(os.path.join(results_path, "c_aggregate.csv"))

    # generation of annual flux results
    runner.run_flux_scenarios().to_csv(os.path.join(results_path, "c_flux.csv"))


if __name__ == "__main__":
    main()

License

This project is licensed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goblin_cbm_runner-0.4.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

goblin_cbm_runner-0.4.2-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file goblin_cbm_runner-0.4.2.tar.gz.

File metadata

  • Download URL: goblin_cbm_runner-0.4.2.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.0 Linux/5.15.0-126-generic

File hashes

Hashes for goblin_cbm_runner-0.4.2.tar.gz
Algorithm Hash digest
SHA256 1d56bc64e77f9ba1b51d1fa9d9d8342856928b91c375687b30af751023bdfb78
MD5 152bde0faf1e678505a159a914474b59
BLAKE2b-256 5707c8c9b0bfa7f81b6a5313c24d4a6545ce334cd8308dd1d0a9de445b2254d9

See more details on using hashes here.

File details

Details for the file goblin_cbm_runner-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: goblin_cbm_runner-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.0 Linux/5.15.0-126-generic

File hashes

Hashes for goblin_cbm_runner-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e9adba7ba16ef1c79abaa05189d7472f19f31d1ac913c52fa9bd19e88ffd379
MD5 954b0da0b9da787fd3c8b50596848a7c
BLAKE2b-256 bf17805686027ddc2a809d8b92a8824635e16a451732f044129d88cac17a8bfc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page