solprop.recipe#

Recipes: a simulation written as a TOML document, built into a Simulation.

A recipe holds the keywords of one route’s constructor, with quantities written in their units ("125 um", "1.2 bar"), and the run’s execution settings. The package re-exports, on first use, Recipe, RecipeIssue, RecipeScan and resume_file (core), RecipeError (errors), and parameters, Parameter, Form and Resolution (metadata). The other modules are the document’s shape and value forms (document), quantities and units (quantity), parameter paths (paths), the registry of buildable types (registry) and their keywords’ metadata (type_metadata), pins (pins), previews (preview), the record a run keeps (provenance) and the Python export (export). The format is SEP 41’s; the manual page is docs/guide/setup/recipes.md.

>>> from solprop.recipe import Recipe
>>> recipe = Recipe.example("rdw")
>>> recipe.route
'capillary'

Modules

core

Recipes: a simulation as versioned TOML, read, built, run and saved (SEP 41, S1).

document

The recipe document: its tables, its format version and the forms of its values.

errors

The error a recipe raises when it cannot be read, checked or written.

export

A recipe written out as the plain Python script a person would write (SEP 41, S1).

metadata

Machine-readable metadata of every keyword a recipe can set (SEP 41, S9).

paths

Parameter paths: the canonical name of every value in a recipe.

pins

Pins: a recipe value set from a design target instead of a literal (SEP 41, S1).

preview

Previews: what a recipe will build, shown before the run (SEP 41, S18).

provenance

The recipe a run records: the authored text, the resolved one, and the data files.

quantity

Quantities in a recipe: numbers with units, read and written back exactly.

registry

From recipe values to the objects a route takes: the registry and the decoder.

type_metadata

Machine-readable metadata of every keyword of a registered type's table (SEP 41, S9).