solprop.cli

The solprop command line: run, check, export and resume recipes (SEP 41, S1).

solprop run recipe.toml -o out.h5 builds and runs a recipe, solprop resume out.h5 continues it from the file alone, solprop check reports what stops it building, solprop export --python prints the equivalent script, and solprop scan is python -m solprop.scan. The same commands run as python -m solprop. The manual page is docs/guide/setup/recipes.md.

Functions

main([argv])

Run the solprop command line.

solprop.cli.main(argv=None)

Run the solprop command line.

Parameters:

argvsequence of str or None, optional

The arguments, or None for the process’s own.

Returns:

int

The exit status: zero on success, one when a recipe has an error, two for a refused recipe or arguments.

Examples

>>> from solprop.cli import main
>>> main(["check", "missing.toml"])
2