Configuration payload
Render a resolved simulation configuration for a provenance record.
Classes¶
Functions:¶
resolved_configuration_payload(configuration: MainConfiguration) -> dict[str, Any]
Return a configuration as the complete, JSON-ready block of a record.
Two things are deliberate here. Every block is present, including the two the
model excludes from an ordinary dump, because a record that claims to carry
the complete configuration has to carry all of it. And the run name, seed and
sample count are removed, because a record states those once -- in its own
run and catalogue blocks, as the run actually used them. Leaving the
declared copies in as well would let a reader find two answers to the same
question and no way to tell which one ran.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
configuration
|
MainConfiguration
|
The resolved configuration, defaults filled in. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
The configuration block of a provenance record. |