pyicat_plus.client.metadata.IcatMetadataClient#

class pyicat_plus.client.metadata.IcatMetadataClient(queue_urls=None, queue_name=None, monitor_port=None, timeout=None)[source]#

Bases: object

Client for storing dataset metadata in ICAT.

Parameters:

  • queue_urls (Optional[List[str]])

  • queue_name (Optional[str])

  • monitor_port (Optional[int])

  • timeout (Optional[float])

check_health()[source]#

Raises an exception when not healthy

disconnect()[source]#
reschedule_investigation(investigation_id)[source]#
Parameters:

investigation_id (str)

send_metadata(beamline, proposal, dataset, path, metadata)[source]#

Send dataset metadata to ICAT.

Parameters:

  • beamline (str) – The beamline name of the proposal.

  • proposal (str) – The proposal name.

  • dataset (str) – The dataset name.

  • path (str) – The path to the dataset on disk.

  • metadata (dict) – A dictionary of metadata to be attached to the dataset.

send_metadata_from_file(filename)[source]#
Parameters:

filename (str)

start_investigation(beamline, proposal, start_datetime=None, end_datetime=None)[source]#
Parameters:

  • beamline (str)

  • proposal (str)

store_metadata(filename, beamline, proposal, dataset, path, metadata)[source]#
Parameters:

  • filename (str)

  • beamline (str)

  • proposal (str)

  • dataset (str)

  • path (str)

  • metadata (dict)