WS4 — Wood Supply Simulation System (Spatially explicit)
A CLI-first, HPC-ready forest estate model for multi-core Linux environments.
WS4 makes spatial structure part of the model: fragments are the decision units, blocks are a runtime aggregate, and adjacency, patch structure, and road access are enforced during simulation and optimization rather than allocated afterwards.
Key invariants
- Launch control files start a run; they do not build one.
- Blocks are a runtime aggregate of fragments; block geometry is not a compile-time input.
- Compilation happens at the fragment level (tracks, curves, treatments, features/products).
- Runtime aggregation: product and feature attributes are summed to the block level on the fly.
- Block treatment operability is the set intersection across a block's constituent fragments. If fragments differ in eligibility/operability, the block's available treatment set can be narrow or empty.
The design favors columnar datasets (Parquet/Arrow), vectorized kernels, and parallel evaluation.
Documentation
AGENTS.md— the working contract for coding agents.ROADMAP.md— the plan of record and issue tracker map.notes/design/ws4-scope.md— problem statement, users, scope, and success criteria.notes/design/ws4-architecture.md— the architecture design.notes/adr/— architecture decision records.
Quick start
# (in a virtualenv)
pip install -e .[geo,opt]
# Build a canonical dataset (from an XML recipe + fragments)
ws4 build --xml path/to/model.xml --fragments path/to/fragments.shp --out build/compiled
# Simulate a given schedule
ws4 simulate --dataset build/compiled --schedule schedules/baseline.csv --years 200 --out out/sim
# Optimize using weighted goal programming (metaheuristic)
ws4 optimize --dataset build/compiled --targets config/targets.yaml --weights config/weights.yaml --threads 32 --time-limit 02:00:00 --out out/runA
Metadata
Release files for ws4 0.2.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 |
|---|---|---|---|---|
| ws4-0.2.0.tar.gz | 596.5 kB | Without provenance | Details for ws4-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ws4-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for ws4-0.2.0-py3-none-any.whl |
Total release size: 1.2 MB
Release files / ws4-0.2.0.tar.gz
| Download URL | ws4-0.2.0.tar.gz |
|---|---|
| Size | 596.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
babb33af7bc7fd528a4be996ff4237b071d38dccecddcf27d84fe672ab5512df
|
|
BLAKE2b-256 checksum How to use checksums |
16a0af8ac97b92786c81ac90d289c800d1366b1e65d42b8ac11cd6a5a429f6c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / ws4-0.2.0-py3-none-any.whl
| Download URL | ws4-0.2.0-py3-none-any.whl |
|---|---|
| Size | 632.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9e740f717e707f17fbd4f504afe75c842ce22e6ced1ba6dd0b95a0deede7efe0
|
|
BLAKE2b-256 checksum How to use checksums |
9381f177f8ca9b06828a50392f305d92e350be3bca1129e847c204a1d90eddca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for ws4 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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
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.