conatus.runs.record

conatus.runs.record(obj=None, *, name=None, params=None, results=None, series=None, fields=None, files=(), compression=REQUIRED, tags=(), status='provisional', parent=None, relation=None, root=None, telemetry=None, notes=None)[source]

Record one finished computation in one call and return the closed run.

obj: a Problem, Plan or solver (numerics, problem hash, explain()), an EVPResult (eigenvalues and residuals stored as fields, n_modes, growth_max, residual_max as results), or any object with explain(). series: {name: 1-D sequence}, all the same length. fields: {name: array}, which requires compression (None, ‘gzip’, ‘lzf’).

Parameters:

  • obj (Any)

  • name (str | None)

  • params (Mapping[str, Any] | None)

  • results (Mapping[str, Any] | None)

  • series (Mapping[str, Any] | None)

  • fields (Mapping[str, Any] | None)

  • files (Iterable[Any])

  • compression (Any)

  • tags (Iterable[str])

  • status (str)

  • parent (Any)

  • relation (str | None)

  • root (Any)

  • telemetry (Any)

  • notes (str | None)

Return type:

Run