Skip to main content

A toolbox for analysing forest sector model results.

Project description

TiMBA Logo

TiMBA Charts

Build Status codecov PyPI License: AGPL v3 DOI PyPI Downloads

This package serves as a toolkit for analysing TiMBA's simulation results. TiMBA is a partial economic equilibrium model for the global forest product market. The package provides a dashboard allowing the user to explore TiMBA’s main results. This includes the development of prices, production, consumption, and trade of forest products as well as forest stock development. It further provides information about historic developments as reported by the FAOSTAT. In principle, this toolkit can be easily adapted and used for the analysis of any forest sector model as long as the data resembles the format of the TiMBA output.

Cite the package

We are happy that you consider to use TiMBA Charts for your research. When publishing your work in articles, working paper, presentations or elsewhere, please cite the package as:

Morland, C., Tandetzki, J. and Honkomp, T. (2025) TiMBA Charts v.1.0.0

Install TiMBA Charts

The package is developed and tested with Python 3.12.6 on Windows. Please ensure that Python is installed on your system. It can be downloaded and installed from Python.org.

Install via Pypi

pip install timba-charts

Install via GitHub

  1. Clone the repository Begin by cloning the repository to your local machine using the following command:

    git clone https://github.com/TI-Forest-Sector-Modelling/TiMBA_Charts

  2. Switch to the TiMBA Charts directory
    Navigate into the project folder on your local machine.

    cd TiMBA_Charts

  3. Create a virtual environment
    It is recommended to set up a virtual environment for TiMBA Charts to manage dependencies. If you are using only a single version of Python on your computer:

    python -m venv .venv

  4. Activate the virtual environment
    Enable the virtual environment to isolate TiMBA Charts dependencies.

    .venv\Scripts\activate

    macOS / Linux:

    source .venv/bin/activate

  5. Install TiMBA Charts in the editable mode

    pip install -e .

If the following error occurs: "ERROR: File "setup.py" or "setup.cfg" not found." you might need to update the pip version you use with:

python.exe -m pip install --upgrade pip

Note: The module requires input data from TiMBA simulations. Before proceeding, please ensure that the simulation results are stored in .../Toolbox/Input/Scenario_Files/ or in the file path specified with the CLI command show_dashboard -FP=. Otherwise, the dashboards will download default data from https://github.com/TI-Forest-Sector-Modelling/TiMBA_Additional_Information.

The same applies to the additional information, which must be located in .../Toolbox/Input/Additional_Information/ or in the path provided with show_dashboard -AIFP=.

Start the dashbords

After installing the package, the user can start the dashboard board with the following CLI command:

show_dashboard

Following CLI command can be used to show all changeable options with the CLI:

show_dashboard --help

At the moment, two options can be changed. The specification of the number of most recent .pkl files to read and the definition of the folder path where the scenario results are stored.

The number of scenarios can be changed as follows:

show_dashboard -NF=4

To change the folder path the user can type, e.g.:

show_dashboard -FP='D:...\data\output'

Description of the dashboards

The interactive dashboard provides a structured and flexible interface for exploring TiMBA model outputs across multiple dimensions. It is designed to support the visualization and validation of at least one TiMBA scenario run.

Historical data from FAOSTAT are integrated into several visualizations. Future updates aim to extend this integration to most figures.

Users can apply filters via dropdown menus and selection panels, including:

  • Scenario
  • Continent
  • Country
  • Domain (Demand, Supply, Trade, Manufacturing, etc.)
  • Commodity
  • Commodity group

Please note that some filter combinations are interdependent and may not return results. For example, selecting Roundwood under the Demand domain yields no output, as roundwood is modeled only on the supply side. Similarly, applying both the commodity and commodity group filters simultaneously does not further restrict the selection, as these categories are not hierarchically structured. This limitation will be addressed in future updates.


i. Overview

The Overview page enables cross-scenario comparison of selected key indicators.

Displayed elements may include:

  • Time series of quantities
  • Price developments
  • Net exports in quantities
  • Forest stock development
  • A world map depicting the largest values from the most recent year of historical data

ii. Forest

The Forest page focuses exclusively on forest-specific indicators.

Displayed indicators include:

  • Forest area development (growth rates and time series)
  • Forest stock development (growth rates and time series)
  • Forest density (stock per unit of area)
  • Total removals (over bark)
  • Net annual increment (NAI, over bark)
  • Total removals as a share of net annual increment

This page supports the assessment of structural forest and forest area dynamics under alternative scenarios.


iii. Price Overview

The Price dahsboard presents price development indicators across time and scenarios.

Examples include:

  • Value growth rates and time series
  • Price growth rates and time series

This enables temporal and cross-scenario price comparisons.


iv. Trade Overview

The Trade dashboard displays international trade dynamics.

It includes:

  • Import quantities and values
  • Export quantities and values
  • Net export quantities and values

This page allows the evaluation of trade shifts across regions and scenarios.


v. Validation

The Validation dashboard compares results from different forest sector models, including:

  • Global Forest Products Model (GFPM)
  • Global Biosphere Management Model (GLOBIOM)
  • Global Timber Model (GTM)
  • TiMBA

The validation is based on publicly available open-access data sources.
Model outputs are compared for selected products, and deviations across models are displayed to validate modeling approaches and projected outcomes.


vi. World Map

The World Map dasboard visualizes spatial changes in quantities between the Reference and Alternative scenarios.

Six domain-specific maps are available:

  • Supply quantity
  • Manufacturing quantity
  • Forest stock
  • Net export quantity
  • Demand quantity
  • Forest area

Countries are color-coded using a gradient scale, allowing geographic comparison of scenario-induced changes.
A specific year can be selected via the map filter to analyze spatial patterns in more detail.


Export Functionality

For any filter combination, users can export:

  • The filtered dataset as a .csv file
  • Individual graphs as .png files

This supports further analysis and documentation.

Authors

License and copyright note

Copyright ©, 2026, Thuenen Institute, Christian Morland, Julia Tandetzki, Tomke Honkomp, wf-timba@thuenen.de

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

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

timba_charts-1.0.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

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

timba_charts-1.0.0-py3-none-any.whl (51.9 kB view details)

Uploaded Python 3

File details

Details for the file timba_charts-1.0.0.tar.gz.

File metadata

  • Download URL: timba_charts-1.0.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for timba_charts-1.0.0.tar.gz
Algorithm Hash digest
SHA256 40bea00333114c2540dcbf9ab978e6e23b8bce3b646fdc8cad43a3272c8dd788
MD5 58e70cd5497ebcda0ec03c9f5e0d375f
BLAKE2b-256 3a40a7f27003cb98a942343d552623b572aa2ac6f6aef3360082485ab8ea8a3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for timba_charts-1.0.0.tar.gz:

Publisher: publish.yml on TI-Forest-Sector-Modelling/TiMBA_Charts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file timba_charts-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: timba_charts-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 51.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for timba_charts-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef50436afe75797c28253d08f21ef1b7debfecbda39785a22b6cf6c4449be921
MD5 0689f82aa08840c2ac2643a7d07d69fe
BLAKE2b-256 932cf1d550acb7989d42291236883d2d6a497756094295636fa6c79093eba1de

See more details on using hashes here.

Provenance

The following attestation bundles were made for timba_charts-1.0.0-py3-none-any.whl:

Publisher: publish.yml on TI-Forest-Sector-Modelling/TiMBA_Charts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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