Skip to main content

fresh-cbm

Exact cached libcbm stand-state tables and lookup client for WS4/FEMIC carbon analyses.

fresh-cbm stores the deterministic per-hectare carbon accounts produced by libcbm for a declared package and treatment family. Consumers can look up a stand state instead of rebuilding a CBM model for every analysis.

Documentation

Published Sphinx site:

https://ubc-fresh.github.io/fresh-cbm/

Start with the cache format, building, and validation guides.

Status

Phase P0 (workflow bootstrap and documentation) is complete. ROADMAP.md is the plan of record; P1 is planned.

Quick start

python -m pip install -e ".[test]"
fresh-cbm-build --help
fresh-cbm-validate --help
fresh-cbm-package --help
fresh-cbm-bench --help
fresh-cbm-verify --help
python -m pytest
python scripts/dashboard.py
sphinx-build -b html docs _build/html -W

The builder and validator require WS4 (ws4[carbon]). Pass --ws4-path or put the WS4 source root on PYTHONPATH; the client and tests do not.

Available cache

v0.1.0-tsa41 is the first published table:

  • 5,273 TSA41 track/age states
  • declared family: untreated + one CC event at offsets 0..49
  • 50 years, 26 carbon accounts, float64
  • 2.85 GB
  • 55 release assets
  • validation: 102 sampled state/offset rows, max absolute error 0

Release: https://github.com/UBC-FRESH/fresh-cbm/releases/tag/v0.1.0-tsa41

v0.1.0-tsa08 is the second package cache:

  • 3,761 TSA08 track/age states
  • untreated + CC@0..49
  • 50 years, 26 accounts, float64
  • 2.03 GB
  • build 2h05; validation 102 rows, max absolute error 0

Release: https://github.com/UBC-FRESH/fresh-cbm/releases/tag/v0.1.0-tsa08

Benchmarks

fresh-cbm-bench measures load, lookup, projection, and storage. On the published TSA41 cache, projection over 148,828 blocks took 2.33 s; TSA08 over 371,565 blocks took 4.96 s. See docs/guides/benchmarks.rst.

How this project works

This project follows the UBC-FRESH dev workflow. Work is planned as phases, tasks, and subtasks in ROADMAP.md, mirrored in GitHub issues, and recorded in CHANGE_LOG.md. The agent contract is AGENTS.md. Read AGENTS.md and ROADMAP.md before changing anything.

Repository map

Path Purpose
AGENTS.md Operating contract for coding agents
ROADMAP.md Plan of record and issue tracker map
CHANGE_LOG.md Dated narrative of changes
docs/ Sphinx site, published to GitHub Pages
notes/ Decisions and focused plans
fresh_cbm/ Python client, manifest schema, family contract, and effect projection
scripts/ Builder, validator, workflow validator, and dashboard
tests/ pytest suite

License

Apache-2.0. See LICENSE.

Metadata

Release files for fresh-cbm 0.2.0

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

Source distribution (sdist)

Source distribution for fresh-cbm 0.2.0
File Size Uploaded Provenance Actions
fresh_cbm-0.2.0.tar.gz 40.0 kB With provenance Details for fresh_cbm-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fresh-cbm 0.2.0
File Interpreter ABI Platform Actions
fresh_cbm-0.2.0-py3-none-any.whl Python 3 none any Details for fresh_cbm-0.2.0-py3-none-any.whl

Total release size: 63.9 kB

Release files / fresh_cbm-0.2.0.tar.gz

Download URL fresh_cbm-0.2.0.tar.gz
Size 40.0 kB
Tags Source
SHA-256 checksum
How to use checksums
dc848a40d86cec2cc5dfa4da64b260163df90b8784ff7e6f5740e1a0b23f7e06
BLAKE2b-256 checksum
How to use checksums
3b7efe21adfc3435a6f1640d0e392a75fd877b557e47701cec149220496840a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 1, 2026.

Transparency log

Release files / fresh_cbm-0.2.0-py3-none-any.whl

Download URL fresh_cbm-0.2.0-py3-none-any.whl
Size 23.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4fa3d9bfbe4f24ed6ca9b4ac3df112d28275ceafcb6a1ea8bc9ea49af54f9ca1
BLAKE2b-256 checksum
How to use checksums
4c75f415d8de3ab417791598b7154ede25c8dc30cee5c4528dd830c5c0468058
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 1, 2026.

Transparency log

Security for fresh-cbm 0.2.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for fresh_cbm-0.2.0.tar.gz

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 Nov 1, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files Full provenance

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