fresh-vdyp
A public, tested Python package for reading the BC VDYP7 coefficient and control bundle, wrapping the VDYP7Console runner, exposing typed yield curves, and validating incremental Python growth equations against the official console outputs.
fresh-vdyp is an interoperability and reimplementation layer. It does not
claim authorship of VDYP7 or BC government data. It exists so the model's
plain-text coefficients, control files, and yield tables can be catalogued,
queried, tested, and used by tools such as FEMIC without a GUI boundary.
Repository: https://github.com/UBC-FRESH/fresh-vdyp
Status
All phases P0-P7 are complete. ROADMAP.md lists the phases,
and GitHub issues carry the live status. The first working milestone is the
source inventory and coefficient catalog, not a full VDYP growth-model rewrite.
What this is
- A parser and catalog for the VDYP7
VDYP_CFG/coebundle. - A control-file map for
VDYP.CTR,VDYPBACK.CTR,.COE,.PRM, and.DAT. - A runner and parser for
VDYP7ConsoleCSV yield tables. - A typed Python curve API and public data assets.
- An incremental Python equation layer validated one family at a time.
- A Typer CLI, FastAPI service, FRESH-style web UI, and bounded LLM assistant.
- A package that FEMIC and other UBC-FRESH tools can depend on.
What this is not
- A claim that UBC-FRESH invented VDYP7.
- A byte-for-byte clone of the native VDYP7 binaries.
- A substitute for measured field data or a complete growth-model validation.
- A place to commit raw government model bundles or credentials.
Source and attribution
Every extracted coefficient, control file, curve, and derived value records:
source
source version
source file
source SHA256
extraction date
citation
The original source remains the BC government's work. Reimplemented logic is
labelled reimplemented and validated against console outputs where possible.
Plan
Read these in order:
notes/plan/0001-program-plan.mdnotes/plan/0002-data-provenance.mdnotes/plan/0003-architecture.mdnotes/plan/0004-validation-release.mdnotes/reference/vdyp-inventory.mdnotes/reference/vdyp-model-map.md
Quick start
This seed is a planning repository. The Python package and data workflows land in Phase 2. Until then, the workflow gates are:
python -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements-dev.txt
python scripts/dashboard.py
Bundle inspection
Until the installable package lands, the first commands run from the repository:
export VDYP_CFG_DIR=/path/to/VDYP_CFG
python scripts/fvdyp_cli.py bundle validate
python scripts/fvdyp_cli.py bundle catalog
python scripts/fvdyp_cli.py bundle extract --output-dir data/normalized
validate checks required files, control targets, and key lookups. catalog
prints the family and row counts. extract writes normalized CSV files plus a
provenance manifest; the CSV files stay under ignored data/normalized/.
Repository map
| Path | Purpose |
|---|---|
AGENTS.md |
Operating contract for coding agents |
HANDOFF.md |
First-read handoff note for a new session agent |
ROADMAP.md |
Plan of record and issue tracker map |
CHANGE_LOG.md |
Dated narrative of changes |
notes/plan/ |
Detailed program, data, architecture, and validation plans |
notes/reference/ |
VDYP inventory and coefficient-map facts |
notes/adr/ |
Accepted design decisions |
docs/ |
Sphinx RTFM surface |
scripts/check_workflow.py |
Workflow validator |
tests/ |
pytest suite, including planning-surface checks |
License and citation
Code is MIT licensed. Coefficient files and model outputs retain their original BC government attribution. Cite the source model and file, not only this package.
Metadata
Release files for fresh-vdyp 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fresh_vdyp-0.1.0.tar.gz | 114.7 kB | With provenance | Details for fresh_vdyp-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fresh_vdyp-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for fresh_vdyp-0.1.0-py3-none-any.whl |
Total release size: 202.0 kB
Release files / fresh_vdyp-0.1.0.tar.gz
| Download URL | fresh_vdyp-0.1.0.tar.gz |
|---|---|
| Size | 114.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ddd595faf40470a1827659a99920f30e559b32e96aaee537dc03dbbfadbee49
|
|
BLAKE2b-256 checksum How to use checksums |
6f8de1e83cf45e167371a1b7a6981301126de023e86e4cc9ccc2f59c75f3e207
|
| 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 9, 2026.
Transparency logRelease files / fresh_vdyp-0.1.0-py3-none-any.whl
| Download URL | fresh_vdyp-0.1.0-py3-none-any.whl |
|---|---|
| Size | 87.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7c4aa18e53fd262349ba209220f309d3e46cc8f423a6790d714433ba4ea3edb4
|
|
BLAKE2b-256 checksum How to use checksums |
626e8ff1aac3a7208850ed30aba8ffca03a1404bb3d33cc40aadfc1a0edfb9f8
|
| 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 9, 2026.
Transparency logSecurity for fresh-vdyp 0.1.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.
Attestation for fresh_vdyp-0.1.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 9, 2026.
Transparency logA 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.