FAIRified & updated README - #124
Merged
ChristianMorland merged 20 commits intoJul 17, 2026
Merged
Conversation
Merge branch 'main' of github.com:hvwaldow/TiMBA
tomkeH
reviewed
Jul 17, 2026
|
|
||
| If you want to develop without using `uv`, you can install TiMBA with `venv` and `pip`, for example for Windows like so: | ||
|
|
||
| The prerequistite is that a supported version (9.9 -3.11) is among your |
Contributor
There was a problem hiding this comment.
Typo correction: prerequisite + Correction: 3.9 instead of 9.9
|
|
||
|
|
||
| ## 3. Use TiMBA | ||
| ## 4. Use TiMBA |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 3. Use TiMBA
| ``` | ||
|
|
||
| ## 4. Supplementary modules | ||
| ## 5. Supplementary modules |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 4. Supplementary modules
| This module estimates carbon stocks in forest biomass, forest soils, deadwood, litter, harvested wood products, and substitution effects based on TiMBA simulation results and historical statistics on forest resources and forest product markets ([Honkomp 2026](https://www.sciencedirect.com/science/article/pii/S2352711026000828#abs0001)). | ||
|
|
||
| ## 5. Project structure | ||
| ## 6. Project structure |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 5. Project structure
| Not all combinations of functionalities and settings have been tested or validated. In particular, shadow and calculated price modes for country- and product-level (PP) and world (WP) prices must be applied consistently. Mixing the two (e.g., PP="calculated_PP" and WP="shadow_WP") is currently not supported and may result in an error. | ||
|
|
||
| ### 6.1. Settings as parameters | ||
| ### 7.1. Settings as parameters |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 6.1. Settings as parameters
| Note: TiMBA was tested with a pre-defined number of periods and respective periods' lenght. If the number of periods is changed, it is necessary to compare and adjust this in the ExogChange sheet in the input file. | ||
|
|
||
| ## 7. TiMBA extended model description | ||
| ## 8. TiMBA extended model description |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 7. TiMBA extended model description
| The model concept bases on the formal description of the Global Forest Products Model (GFPM) (Buongiorno et al. 2015, Buongiorno et al. 2003). | ||
|
|
||
| ## 8. Supplementary modules for TiMBA | ||
| ## 9. Supplementary modules for TiMBA |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 8. Supplementary modules for TiMBA
| | TiMBA Charts | an analysis toolbox with multiple dashboards about the main TiMBA results | `timba run -SD True` to open the toolbox directly after simulation has ended, or `timba dashboard` to open the toolbox indepently from a specific TiMBA run | [TiMBA Charts](https://github.com/TI-Forest-Sector-Modelling/TiMBA_Charts) | [Morland, C., Tandetzki, J., & Honkomp, T. (2026)](https://doi.org/10.5281/zenodo.20925292) | | ||
|
|
||
| ## 9. Roadmap and project status | ||
| ## 10. Roadmap and project status |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 9. Roadmap and project status
| ```text | ||
| results_D20260708T14-32-18.csv | ||
| ``` | ||
| ## 7. Model settings |
Contributor
There was a problem hiding this comment.
Error in chapter number. Correction: 6. Model settings
| - [2.4 Install TiMBA from PyPi](#24-install-timba-from-pypi) | ||
| - [2.5 Install TiMBA from GitHub](#25-install-timba-from-github) | ||
| - [3. Testing TiMBA](#3-testing-timba) | ||
| - [4. Use TiMBA](#4-use-timba) |
Contributor
There was a problem hiding this comment.
Update chapter overview to account for changes in chapters
ChristianMorland
merged commit Jul 17, 2026
1456c6f
into
TI-Forest-Sector-Modelling:main
6 of 7 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ok, I have produced a new README, based on previous FAIRification also with additions and corrections from the meeting today and taking care to modernize for the new subcommand CLI. I am very happy with content and structure now. Maybe you guys want to spellcheck and look for shallow errors (sorry I have to run now).
In any case, I think this is all very nice, good chances to make a very good impression as is => go run with it ;).