API reference

The API reference lists the public objects for custom work, in the same three groups as the overview. What most models need is in the Overview.

Errors

Every error derives from DiffSoupError.

diff_soup.DiffSoupError

Base class of the errors specific to diff-soup.

diff_soup.ConfigurationError

Raised when an argument, an option, or a combination of them is invalid.

diff_soup.LoweringError

Raised when spec.build() or lower cannot turn its input into a problem.

A typical cause is a boundary function that reads a field its component neither owns nor couples in. The message names the declaration and the fix.

diff_soup.BackendError

Raised when a batched evaluation of a study fails while it runs, for example when device memory runs out.

diff_soup.OptionalDependencyError

Raised when a feature needs an optional package that is not installed.

It subclasses ImportError. The message names the install command.