Wood Supply Simulation System (ws3)
Welcome to the Wood Supply Simulation System (ws3) documentation.
ws3 is an open-source Python package for landscape-level wood supply simulation
and forest estate modelling.
Who Is This Documentation For?
This documentation serves three audiences:
New users — forest planners, students, and land managers who want to run their first wood supply simulation. Start with Getting Started.
Advanced users — researchers and analysts building custom scenarios, linking ws3 to other tools, or extending the API. See How-To Guides and Advanced Guides.
LLM coding agents — AI assistants that read and edit this repository. Follow VS Code and Coding-Agent Onboarding and the Technical Contracts to understand the data contracts, runtime invariants, and repository conventions the agent must respect.
The ws3 documentation also doubles as an introduction to forest estate modelling for students. The The ws3 Textbook section teaches the underlying concepts — from forest inventory through growth-and-yield projection to multi-period planning — using ws3 as the working example.