abtools.pipeline: Utilities for building pipelines of AbTools functions

abtools.pipeline.initialize(log_file, project_dir=None, debug=False)

Initializes an AbTools pipeline.

Initialization includes printing the AbTools splash, setting up logging, creating the project directory, and logging both the project directory and the log location.

Parameters:
  • log_file (str) – Path to the log file. Required.
  • project_dir (str) – Path to the project directory. If not provided, the project directory won’t be created and the location won’t be logged.
  • debug (bool) – If True, the logging level will be set to logging.DEBUG. Default is FALSE, which logs at logging.INFO.
Returns:

logger

abtools.pipeline.make_dir(d)

Makes a directory, if it doesn’t already exist.

Parameters:d (str) – Path to a directory.
abtools.pipeline.list_files(d, extension=None)

Lists files in a given directory.

Parameters:
  • d (str) – Path to a directory.
  • extension (str) – If supplied, only files that contain the specificied extension will be returned. Default is False, which returns all files in d.
Returns:

A sorted list of file paths.

Return type:

list