fairmd.lipids.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.

fairmd.lipids.utils.run_analysis(method: Callable, logger: Logger, id_range=None, id_list=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 – System IDs range to analyse. Input of list with length = 2, id_range = [start_ID, end_ID]. Can be [None, X] which means all systems with ids<=X or [X, None] which runs ids>=X.
id_list – System ID list to analyse. Must provide either a id_list or id_range.

Environment variables:

fmdl_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.