Storage

Storage is a Pyrame module that manages data created by other modules and its inclusion on the RunDB <cmd_rundb>.

Storage allows to use a mount point and a path to transparently store data elsewhere in the network. It also automates common tasks such as saving the calxml configuration and a log with optional varmod variables (e.g.: stats) at the same place as data files.

API

cmd_storage.init_storage(storage_id, use_rundb, brg_name, brg_mp, brg_path, brg_parent_id, elog_server, elog_name, stats_names, producers_count)

Initialize storage named storage_id.

use_rundb (1/0) indicates if the RunDB should be populated. brg arguments refer to the base run group: brg_mp mount point, brg_path path relative the the mount point, brg_parent_id RunDB id of the brg parent.

elog_server and elog_name describe the elog to be used, if any.

stats_names is a comma-separated list of varmod variables to be stored on the log of the acquisitions.

producers_count is an integer with the number of producers that will call the function mark_as_finished_storage. Once all of them will have called the function, storage will mark the aquisition as finished.

cmd_storage.config_storage(storage_id)

Configure storage_id. Init elog, if any

cmd_storage.inval_storage(storage_id)

Invalidate storage_id. Deinit elog, if any

cmd_storage.deinit_storage(storage_id)

Deinitialize storage_id

cmd_storage.register_producer_storage(storage_id)

Register a new producer for the storage

cmd_storage.new_run_storage(storage_id, run_name, mode='append')

Create run with run_name on storage_id. mode can be append (do not remove anything) or remove (if something exists with the same name it is removed before starting).

cmd_storage.set_param_run_storage(storage_id, run_name, param, value)

Set a parameter param with value for run_name on storage_id. If use_rundb (init_storage) is 0, this function does nothing.

cmd_storage.new_acq_storage(storage_id, acq_name, run_name, mode='append', convert_script='undef')

Create acquisition with acq_name in run_name. mode can be append (do not remove anything: reuse or append) or remove (if something exists with the same name it is removed before starting). At the end of the acquistion launch convert_script

cmd_storage.set_param_acq_storage(storage_id, acq_id, param, value)

Set a parameter param with value for acq_id on storage_id. If use_rundb (init_storage) is 0, this function does nothing.

cmd_storage.is_acq_finished_storage(storage_id, acq_id)

Check if acquisition acq_id is finished at storage_id. The RunDB is used to know when the acquisition is finished. If use_rundb is 0, this function returns 1.

cmd_storage.is_run_finished_storage(storage_id, run_id)

Check if all acquisitions in run_id are finished at storage_id. The RunDB is used to know when the acquisitions are finished. If use_rundb is 0, this function returns 1.