Skip to main content

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.1

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

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/.

Metadata

Release files for TiMBA-Charts 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for TiMBA-Charts 1.0.3
File Size Uploaded
timba_charts-1.0.3.tar.gz 49.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for TiMBA-Charts 1.0.3
File Interpreter ABI Platform
timba_charts-1.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 102.1 kB

Release files / timba_charts-1.0.3.tar.gz

Download URL timba_charts-1.0.3.tar.gz
Size 49.7 kB
Tags Source
SHA-256 checksum
How to use checksums
30ee763432d31f2562af26bb2ca8afd841c3c5bf6b501a7636b2c1d732b28550
BLAKE2b-256 checksum
How to use checksums
b3de2144454ba0526a0c6c11a92464b61226ee51a2d15e79058d85aa60fe697a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release files / timba_charts-1.0.3-py3-none-any.whl

Download URL timba_charts-1.0.3-py3-none-any.whl
Size 52.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f9f9640c24940b1bc18b3382b8d065df7e4d56b98332a2282afb3d75ef9a9cb5
BLAKE2b-256 checksum
How to use checksums
741e1153c50fb102cb1f5d37995b17b70651c367446361b768f2bd2d54b9031e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page