From 3805bca6d75415fd74df666607fdc82eae6c4182 Mon Sep 17 00:00:00 2001 From: tomke honkomp Date: Thu, 4 Dec 2025 11:26:39 +0100 Subject: [PATCH 1/3] Update README for new path setting option --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7d7b88..f2d4e4d 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ To install the newest version of the C-Module via PyPI, use following command in ### Installation 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/C-Module + >git clone https://github.com/TI-Forest-Sector-Modelling/C-Module.git > 2. Switch to the C-Module directory Navigate into the C-Module project folder on your local machine. @@ -136,6 +136,16 @@ By running the provided example, the C-Module will calculate carbon stocks and s in forest belowground biomass (-CF_BGB), and in HWP (-C_HWP). Carbon stocks and stock changes in forest soil (-CF_S) and dead wood and litter (-CF_DWL) will not be calculated. +The target folder for input and output data of the C-Module can be changed from the default settings (\C-Module\c_module\data) +by specifying -FP when executing the package from the CLI. + >run_cmodule -SC 1 -FP "\your_folderpath" + +If executed from an IDE, a target folder can be specified in `default_parametres.py` using +`folderpath = "\your_folderpath"`. + +When specifying a target folder, necessary input data from the GitHub repository will be automatically downloaded to ensure +the functionlity of the package. The provided path should match OS-specific requirements. + ### Test suite and coverage report The C-Module comes with a test suite to ensure its functionality and allow for continuous and safe development. The test suite is triggered automatically in GitHub Actions when pushing or pulling into the main branch. @@ -245,6 +255,7 @@ Basic module settings include: | `hist_hwp_start_year_default` | Setting to control the reference year for the historical HWP pool.
Used in combination with `hist_hwp_start_year`="default" | int | 2020 (start year) | | `show_carbon_dashboard` | Setting to control if the dashboard for explorative result exploration is launched | Bool | True | | `fao_data_update` | Setting to control if FAO data (FRA and FAOSTAT) is updated or not | Bool | False | +| `folderpath` | Setting to control the target folder for input and output data | None or str | None | If the C-Module is used as an add-on to TiMBA, the start and end year parameters are automatically adjusted to match TiMBA's start and end years. The C-Module is delivered with a set of default settings, which were tested and validated. The default settings can be changed when executing the From 246d8e6b8a93f9fe1f80e3fa209e4a544aa3f175 Mon Sep 17 00:00:00 2001 From: tomke honkomp Date: Thu, 4 Dec 2025 11:27:28 +0100 Subject: [PATCH 2/3] Update version number for release --- CITATION.cff | 4 ++-- pyproject.toml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index c4f3b7f..8200697 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -31,5 +31,5 @@ keywords: - wood products - forest sector modelling license: AGPL-3.0-or-later -version: 1.1.1 -date-released: '03.09.2025' +version: 1.1.2 +date-released: '04.12.2025' diff --git a/pyproject.toml b/pyproject.toml index 559c6a5..ce904e0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "Carbon-Module" -version = "1.1.1" +version = "1.1.2" authors = [{name = "Tomke Honkomp", email = "tomke.honkomp@thuenen.de"}] description = "The C-Module tracks global carbon stocks and stock changes across pools of the forestry sector, displaying them interactively" readme = "README.md" @@ -43,7 +43,7 @@ classifiers = [ ] [project.urls] -Homepage = "https://placeholder.com" +Homepage = "https://github.com/TI-Forest-Sector-Modelling" Documentation = "https://placeholder.com" Repository = "https://github.com/TI-Forest-Sector-Modelling/C-Module" Issues = "https://github.com/TI-Forest-Sector-Modelling/C-Module/issues" From 813594890713b6d89a7483c7a870eedea54ec8db Mon Sep 17 00:00:00 2001 From: tomke honkomp Date: Thu, 4 Dec 2025 11:27:47 +0100 Subject: [PATCH 3/3] Update CHANGELOG.md for release --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7de0e77..de83449 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [v1.1.2] - 2025-12-04 + +### Added + +- Dynamic path setting allowing a flexible usage of the C-Module in combination with other packages (such as TiMBA). +- Safeguards to prevent errors related to missing input data. In the case of missing input data, missing files are +automatically downloaded from GitHub. +- CLI refinement to integrate dynamic path setting. + ## [v1.1.1] - 2025-09-16 ### Added