![TiMBA Logo](https://raw.githubusercontent.com/TI-Forest-Sector-Modelling/TiMBA_Additional_Information/main/images/toolbox_assets/timba_charts_logo.png)


# TiMBA Charts

[![Build Status](https://github.com/TI-Forest-Sector-Modelling/TiMBA_Charts/actions/workflows/actions.yml/badge.svg)](https://github.com/TI-Forest-Sector-Modelling/TiMBA_Charts/actions/workflows/actions.yml)
[![codecov](https://codecov.io/gh/TI-Forest-Sector-Modelling/TiMBA_Charts/graph/badge.svg?token=S4TDJI4CC3)](https://codecov.io/gh/TI-Forest-Sector-Modelling/TiMBA_Charts)
![PyPI](https://img.shields.io/pypi/v/TiMBA_Charts)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![DOI](https://zenodo.org/badge/883749241.svg)](https://zenodo.org/badge/latestdoi/883749241)
[![PyPI Downloads](https://static.pepy.tech/badge/timba-charts)](https://pepy.tech/projects/timba-charts)

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](https://www.python.org/downloads/release/python-3126/).

### 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](https://github.com/TI-Forest-Sector-Modelling/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](https://www.fao.org/faostat/en/#data/FO) 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
- [Christian Morland](https://www.thuenen.de/de/fachinstitute/waldwirtschaft/personal/wissenschaftliches-personal/ehemalige-liste/christian-morland-msc) [(ORCID 0000-0001-6600-570X)](https://orcid.org/0000-0001-6600-570X),
- [Julia Tandetzki](https://www.thuenen.de/de/fachinstitute/waldwirtschaft/personal/wissenschaftliches-personal/julia-tandetzki-msc) [(ORCID 0000-0002-0630-9434)](https://orcid.org/0000-0002-0630-9434) and 
- [Tomke Honkomp](https://www.thuenen.de/de/fachinstitute/waldwirtschaft/personal/wissenschaftliches-personal/tomke-honkomp-msc) [(ORCID 0000-0002-6719-0190)](https://orcid.org/0000-0002-6719-0190). 

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


