Getting started

WS4 has two ways in, and most people need only one of them:

  • The command line. One command per step of a study, from compiling a dataset to writing a report. No Python, nothing to import. Start with Quickstart: the command line.

  • The Python API. The same steps as library calls, for automation, custom diagnostics, sensitivity sweeps, and integration with other tools. Start with Quickstart: the Python API.

Both paths read and write the same files, and both can be mixed: a command-line run can be resumed in Python, and a Python study can shell out to the commands it does not want to reimplement.

Page

What it covers

Installation

Requirements, the optional extras, and a three-command install check.

Quickstart: the command line

The command-line walkthrough: compile, simulate, target, search, watch.

Quickstart: the Python API

The same walkthrough as Python, plus the in-memory evaluator and a hand-driven search.

Your first model

A complete small study, with the numbers checked by hand.

How WS4 is put together

How the parts fit together, and the pitfalls that follow from the design.