Logging is an essential part of reproducible workflows. In CWARHM code provenance is included in every script. In the package, this should be centrally arranged through making use of python logging.
logging should / could contain :
[ ] the hash of the head (which points to an exact commit, which can be referenced in the future
[ ] a list of all the packages in the environment (i.e. a conda list)
[ ] versions and data of retrieval of datasets (metadata)
[ ] written files should include metadata where possible (especially netcdf)
For usability
[ ] tracking the progress of which function is running and what it is doing
Logging is an essential part of reproducible workflows. In CWARHM code provenance is included in every script. In the package, this should be centrally arranged through making use of python logging.
logging should / could contain :
For usability
[ ] tracking the progress of which function is running and what it is doing
[ ] debug messages
[ ]