DatabankLib.utils module

Utility functions for Datbank standalone scripts.

Currently only run_analysis, which runs a given analysis method on a range of systems in the databank.

DatabankLib.utils.run_analysis(method: Callable, logger: Logger, id_range=(None, None)) → None[source]

Apply analysis method to the entire databank.

Parameters:

  • method – (Callable) will be called as fun(system, logger)

  • logger – (Logger) reference to Logger initialized by the top script

  • id_range – (A,B) filter for systems to analyze, default is (None, None) which means all systems. Can be also (None, -1) which means all new systems, or (0, None) which means all old systems.

Environment variables:

  • NML_STRICT_MODE: if set to "true" or "1" (case-insensitive), the function will exit with code RCODE_ERROR if one or more analyses fail. When unset, empty, or any other value, failed analyses are only logged and execution continues normally.

Returns:

None