camacq.helper package¶
Helper functions for camacq.
-
camacq.helper.
ensure_dict
(value)¶ Convert None to empty dict.
-
camacq.helper.
get_module
(package, module_name)¶ Return a module from a package.
- Parameters
package (str) – The path to the package.
module_name (str) – The name of the module.
-
camacq.helper.
has_at_least_one_key
(*keys)¶ Validate that at least one key exists.
-
camacq.helper.
register_signals
(center)¶ Register signal handlers.
-
async
camacq.helper.
setup_one_module
(center, config, module)¶ Set up one module or package.
- Returns
Return a task to set up the module or None.
- Return type
asyncio.Task
Submodules¶
camacq.helper.template module¶
Handle templates.
-
camacq.helper.template.
get_env
(center)¶ Get the template environment.
-
camacq.helper.template.
make_template
(center, data)¶ Make templated data.
-
camacq.helper.template.
render_template
(data, variables)¶ Render templated data.
-
camacq.helper.template.
template_next_well_x
(sample, plate_name, x_wells=12, y_wells=8)¶ Return the next well x coordinate for the plate x, y format.
-
camacq.helper.template.
template_next_well_xy
(sample, plate_name, x_wells=12, y_wells=8)¶ Return the next not done well for the given plate x, y format.
-
camacq.helper.template.
template_next_well_y
(sample, plate_name, x_wells=12, y_wells=8)¶ Return the next well x coordinate for the plate x, y format.