11. Provenance tracking

Describe outputs for provenance tracking.

hypnotoad_inputs

String containing an plain text formatted table of the input parameters.

hypnotoad_inputs_yaml

String containing the inputs in YAML format. Can be used to recreate an input file that can be used to rebuild the grid, see hypnotoad-recreate-inputs.

hypnotoad_input_geqdsk_file_contents

String with a copy of the geqdsk file used to create the grid file. Can be extracted using hypnotoad-recreate-inputs.

Python_version

Python version that was used to run hypnotoad when the grid file was generated.

module_versions

String with a list of all the Python modules that were loaded at the time that hypnotoad was run, and their versions.

11.1. hypnotoad-recreate-inputs

Recreate input files that were used to create the grid from a hypnotoad grid file

usage: hypnotoad-recreate-inputs [-h] [-g GFILE_OUT] [-y YAML_OUT] grid_file

Positional Arguments

grid_file

Named Arguments

-g, --gfile-out

Name for recreated gfile. Defaults to name of original gfile.

-y, --yaml-out

Default: “hypnotoad.yaml”