How-to guides

Task-shaped guides for the work WS4 is used for. Each one is self-contained, states what you need first, and calls out the traps. Every command and snippet was run against the repository’s own example, and the output shown is the output it produced.

Two columns are worth noting: CLI guides are pure command line, API guides are Python, and guides marked both show each path where they differ.

Guide

Mode

What it does

Prepare a dataset

both

Compile a recipe and a fragment inventory, import an existing matrix, and validate.

Write targets

both

State what you want: accounts, levels, weights, shapes, periods, and how to balance them.

Even flow and non-declining yield

both

Hold a harvest profile flat, or stop a closing inventory declining, including the priming step that makes the term finite.

Patch size-distribution targets

both

Require that harvesting lands as openings of a size you choose, using block topology.

Route products to mills

both

Send products over a road network to mills, and target the haul, build, and maintenance accounts.

Running a carbon study

both

Run a FEMIC carbon package through a baseline, an optimizer target, and optional fertilization, and read the carbon accounts.

Watch a run

both

Watch realized against target values while a search runs, one window per account.

Automate a study

API

Sweeps, seeds, and reading results back — what the Python API is for.

Run an allowlisted command

both

Run allowlisted WS4 commands from the web UI through typed fields, not a shell.

Frequently asked questions

both

Short answers to the questions that come up first.

Prerequisites