cosmic_ray.commands package

Submodules

cosmic_ray.commands.execute module

Implementation of the ‘execute’ command.

cosmic_ray.commands.execute.execute(work_db, config: ConfigDict)

Execute any pending work in the database work_db, recording the results.

This looks for any work in work_db which has no results, schedules it to be executed, and records any results that arrive.

cosmic_ray.commands.init module

Implementation of the ‘init’ command.

cosmic_ray.commands.init.init(module_paths, work_db: WorkDB, operator_cfgs)

Clear and initialize a work-db with work items.

Any existing data in the work-db will be cleared and replaced with entirely new work orders. In particular, this means that any results in the db are removed.

Parameters:

• module_paths – iterable of pathlib.Paths of modules to mutate.

• work_db – A WorkDB instance into which the work orders will be saved.

• operator_cfgs – A dict mapping operator names to parameterization dicts.

Raises:

TypeError – Arguments provided for an operator are invalid.

cosmic_ray.commands.new_config module

Implementation of the ‘new-config’ command.

cosmic_ray.commands.new_config.new_config()

Prompt user for config variables and generate new config.

Returns: A new ConfigDict.

Module contents

These are the core implementations of the various commands in cosmic ray.

Not all commands are represented here, just the ones which seem big enough to justify a separate module.