Skip to main content
Ctrl+K

pyicat-plus 2.1

  • Raw Dataset
  • Processed Dataset
  • Dataset Metadata
  • Other features
  • API documentation
  • gitlab
  • pypi
  • Raw Dataset
  • Processed Dataset
  • Dataset Metadata
  • Other features
  • API documentation
  • gitlab
  • pypi

Section Navigation

  • pyicat_plus
    • pyicat_plus.apps
      • pyicat_plus.apps.icat_as_nexus
        • pyicat_plus.apps.icat_as_nexus.main
        • pyicat_plus.apps.icat_as_nexus.save_icat_as_nexus
      • pyicat_plus.apps.store_from_file
        • pyicat_plus.apps.store_from_file.add_store_parameters
        • pyicat_plus.apps.store_from_file.apply_store_parameters
        • pyicat_plus.apps.store_from_file.main
      • pyicat_plus.apps.store_processed
        • pyicat_plus.apps.store_processed.add_process_parameters
        • pyicat_plus.apps.store_processed.apply_process_parameters
        • pyicat_plus.apps.store_processed.main
      • pyicat_plus.apps.store_raw
        • pyicat_plus.apps.store_raw.add_store_parameters
        • pyicat_plus.apps.store_raw.apply_store_parameters
        • pyicat_plus.apps.store_raw.main
      • pyicat_plus.apps.sync_raw
        • pyicat_plus.apps.sync_raw.main
        • pyicat_plus.apps.sync_raw.sync_raw
        • pyicat_plus.apps.sync_raw.sync_session
    • pyicat_plus.client
      • pyicat_plus.client.add_files
        • pyicat_plus.client.add_files.IcatAddFilesClient
      • pyicat_plus.client.archive
        • pyicat_plus.client.archive.IcatArchiveStatusClient
      • pyicat_plus.client.bliss
        • pyicat_plus.client.bliss.get_icat_client
      • pyicat_plus.client.defaults
      • pyicat_plus.client.deprecation_utils
        • pyicat_plus.client.deprecation_utils.deprecated_argument
        • pyicat_plus.client.deprecation_utils.deprecated_method
        • pyicat_plus.client.deprecation_utils.deprecated_property
        • pyicat_plus.client.deprecation_utils.warn_deprecated_module
      • pyicat_plus.client.elogbook
        • pyicat_plus.client.elogbook.IcatElogbookClient
      • pyicat_plus.client.icatplus_restricted
        • pyicat_plus.client.icatplus_restricted.IcatPlusRestrictedClient
      • pyicat_plus.client.interface
        • pyicat_plus.client.interface.IcatClientInterface
      • pyicat_plus.client.investigation
        • pyicat_plus.client.investigation.IcatInvestigationClient
      • pyicat_plus.client.main
        • pyicat_plus.client.main.IcatClient
      • pyicat_plus.client.messaging
        • pyicat_plus.client.messaging.IcatMessagingClient
      • pyicat_plus.client.metadata
        • pyicat_plus.client.metadata.IcatMetadataClient
      • pyicat_plus.client.models
        • pyicat_plus.client.models.session
      • pyicat_plus.client.null
        • pyicat_plus.client.null.IcatNullClient
      • pyicat_plus.client.types
        • pyicat_plus.client.types.ArchiveStatusLevel
        • pyicat_plus.client.types.ArchiveStatusType
        • pyicat_plus.client.types.Dataset
        • pyicat_plus.client.types.DatasetId
        • pyicat_plus.client.types.DatasetMetadata
        • pyicat_plus.client.types.SampleMetadata
      • pyicat_plus.client.update_metadata
        • pyicat_plus.client.update_metadata.IcatUpdateMetadataClient
    • pyicat_plus.concurrency
      • pyicat_plus.concurrency.flush_queue
      • pyicat_plus.concurrency.spawn
      • pyicat_plus.concurrency.wait_process
    • pyicat_plus.errors
      • pyicat_plus.errors.invalid_warn_or_raise
      • pyicat_plus.errors.warn
      • pyicat_plus.errors.IcatMetadataDeprecatedWarning
      • pyicat_plus.errors.IcatMetadataFutureWarning
      • pyicat_plus.errors.IcatMetadataSerializationError
      • pyicat_plus.errors.IcatMetadataValidationError
      • pyicat_plus.errors.IcatMetadataValidationWarning
    • pyicat_plus.metadata
      • pyicat_plus.metadata.definitions
        • pyicat_plus.metadata.definitions.as_icatnodeid
        • pyicat_plus.metadata.definitions.icat_fields_source
        • pyicat_plus.metadata.definitions.load_group
        • pyicat_plus.metadata.definitions.load_icat_fields
        • pyicat_plus.metadata.definitions.IcatCategory
        • pyicat_plus.metadata.definitions.IcatField
        • pyicat_plus.metadata.definitions.IcatFieldGroup
        • pyicat_plus.metadata.definitions.IcatGroup
        • pyicat_plus.metadata.definitions.IcatNodeId
      • pyicat_plus.metadata.drac_report_builder
        • pyicat_plus.metadata.drac_report_builder.DracReportBuilder
      • pyicat_plus.metadata.namespace_wrapper
        • pyicat_plus.metadata.namespace_wrapper.NamespaceWrapper
      • pyicat_plus.metadata.nexus
        • pyicat_plus.metadata.nexus.as_nxtype
        • pyicat_plus.metadata.nexus.create_nxtreedict
    • pyicat_plus.tests
      • pyicat_plus.tests.conftest
        • pyicat_plus.tests.conftest.esrfet_version
        • pyicat_plus.tests.conftest.icat_namespace
        • pyicat_plus.tests.conftest.ignore_icat_message_warnings
      • pyicat_plus.tests.fixtures
        • pyicat_plus.tests.fixtures.icat
        • pyicat_plus.tests.fixtures.misc
        • pyicat_plus.tests.fixtures.proc
        • pyicat_plus.tests.fixtures.tcp
      • pyicat_plus.tests.icat_messaging
        • pyicat_plus.tests.icat_messaging.test_dataset
        • pyicat_plus.tests.icat_messaging.test_fallback
        • pyicat_plus.tests.icat_messaging.test_investigation
      • pyicat_plus.tests.servers
        • pyicat_plus.tests.servers.activemq_rest_server
        • pyicat_plus.tests.servers.coilmq
        • pyicat_plus.tests.servers.icat_db
        • pyicat_plus.tests.servers.icat_session
        • pyicat_plus.tests.servers.icatplus_server
        • pyicat_plus.tests.servers.stomp_publisher
        • pyicat_plus.tests.servers.stomp_subscriber
        • pyicat_plus.tests.servers.utils
      • pyicat_plus.tests.test_cli
        • pyicat_plus.tests.test_cli.test_store_from_file
        • pyicat_plus.tests.test_cli.test_store_processed
        • pyicat_plus.tests.test_cli.test_store_raw
        • pyicat_plus.tests.test_cli.test_store_raw_metadatafile
      • pyicat_plus.tests.test_drac_report_builder
        • pyicat_plus.tests.test_drac_report_builder.test_escape_characters
        • pyicat_plus.tests.test_drac_report_builder.test_render_image_in_html
        • pyicat_plus.tests.test_drac_report_builder.test_render_image_with_thumbnail
        • pyicat_plus.tests.test_drac_report_builder.test_render_json_and_html
      • pyicat_plus.tests.test_elogbook
        • pyicat_plus.tests.test_elogbook.test_ebs_elogbook_message
        • pyicat_plus.tests.test_elogbook.test_elogbook_data
        • pyicat_plus.tests.test_elogbook.test_elogbook_data_beamline_only
        • pyicat_plus.tests.test_elogbook.test_elogbook_message
        • pyicat_plus.tests.test_elogbook.test_elogbook_message_beamline_only
        • pyicat_plus.tests.test_elogbook.test_elogbook_message_options
        • pyicat_plus.tests.test_elogbook.test_elogbook_message_wrong_category
      • pyicat_plus.tests.test_icat_add_files
        • pyicat_plus.tests.test_icat_add_files.add_files
        • pyicat_plus.tests.test_icat_add_files.test_add_files
        • pyicat_plus.tests.test_icat_add_files.test_add_files_raises_error_if_dataset_id_is_missing
      • pyicat_plus.tests.test_icat_archive
        • pyicat_plus.tests.test_icat_archive.test_send_archive_status
        • pyicat_plus.tests.test_icat_archive.test_send_archive_status_raises_error_if_dataset_id_missing
        • pyicat_plus.tests.test_icat_archive.test_send_archive_status_raises_error_if_level_missing
        • pyicat_plus.tests.test_icat_archive.test_send_archive_status_raises_error_if_type_missing
      • pyicat_plus.tests.test_icat_datasets
        • pyicat_plus.tests.test_icat_datasets.test_reschedule_investigation
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_definition_warning
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_input_datasets_relative_path_warning
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_normpath
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_path_defects
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_relative_path_warning
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_via_file
        • pyicat_plus.tests.test_icat_datasets.test_send_metadata_with_machine_software
        • pyicat_plus.tests.test_icat_datasets.test_send_missing_data
        • pyicat_plus.tests.test_icat_datasets.test_send_missing_metadata
        • pyicat_plus.tests.test_icat_datasets.test_start_bad_investigation
        • pyicat_plus.tests.test_icat_datasets.test_start_investigation
      • pyicat_plus.tests.test_icat_definitions
        • pyicat_plus.tests.test_icat_definitions.test_find_groups_by_item_id
        • pyicat_plus.tests.test_icat_definitions.test_getitem
        • pyicat_plus.tests.test_icat_definitions.test_node_id
      • pyicat_plus.tests.test_icat_investigations
        • pyicat_plus.tests.test_icat_investigations.test_investigation_dateonly
        • pyicat_plus.tests.test_icat_investigations.test_investigation_inbetween
        • pyicat_plus.tests.test_icat_investigations.test_investigation_inside
        • pyicat_plus.tests.test_icat_investigations.test_investigation_none
        • pyicat_plus.tests.test_icat_investigations.test_investigation_outside
      • pyicat_plus.tests.test_icat_mockup
        • pyicat_plus.tests.test_icat_mockup.test_activemq_rest_server
        • pyicat_plus.tests.test_icat_mockup.test_icat_logbook_server
        • pyicat_plus.tests.test_icat_mockup.test_stomp
      • pyicat_plus.tests.test_icat_nexus
        • pyicat_plus.tests.test_icat_nexus.test_icat_metadata_to_hdf5
        • pyicat_plus.tests.test_icat_nexus.test_icat_metadata_to_nexus
      • pyicat_plus.tests.test_icat_restricted
        • pyicat_plus.tests.test_icat_restricted.test_download_file_by_sample_parametrized
        • pyicat_plus.tests.test_icat_restricted.test_get_investigations_by
        • pyicat_plus.tests.test_icat_restricted.test_get_parcels_by
        • pyicat_plus.tests.test_icat_restricted.test_get_sample_files_information_by
        • pyicat_plus.tests.test_icat_restricted.test_get_sample_metadata_by
        • pyicat_plus.tests.test_icat_restricted.test_get_samples_by
        • pyicat_plus.tests.test_icat_restricted.test_get_samples_by_returns_expected_data
        • pyicat_plus.tests.test_icat_restricted.test_login
        • pyicat_plus.tests.test_icat_restricted.test_login_with_username_plugin
      • pyicat_plus.tests.test_icat_sync
        • pyicat_plus.tests.test_icat_sync.test_missing_files_datasets
        • pyicat_plus.tests.test_icat_sync.test_session_pprint
        • pyicat_plus.tests.test_icat_sync.test_session_serialization
        • pyicat_plus.tests.test_icat_sync.test_unregistered_datasets
        • pyicat_plus.tests.test_icat_sync.test_unregistered_datasets_content
      • pyicat_plus.tests.test_icat_update_metadata
        • pyicat_plus.tests.test_icat_update_metadata.send_update_metadata
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_beamline_is_missing
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_dataset_paths_is_empty
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_dataset_paths_is_missing
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_metadata_name_is_missing
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_metadata_value_is_missing
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_raises_error_if_proposal_is_missing
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_sample
        • pyicat_plus.tests.test_icat_update_metadata.test_send_update_metadata_sample_with_multiple_datasets
      • pyicat_plus.tests.test_maxsizedict
        • pyicat_plus.tests.test_maxsizedict.test_maxsizedict
      • pyicat_plus.tests.test_namespace
        • pyicat_plus.tests.test_namespace.test_namespace_str
      • pyicat_plus.tests.test_raw_data
        • pyicat_plus.tests.test_raw_data.create_folder
        • pyicat_plus.tests.test_raw_data.test_get_dataset_filters_should_raise_exception_if_invalid_format
        • pyicat_plus.tests.test_raw_data.test_get_dataset_filters_should_return_expected_path_for_esrf_id16bspec_format
        • pyicat_plus.tests.test_raw_data.test_get_dataset_filters_should_return_expected_path_for_mx_format
      • pyicat_plus.tests.test_url_utils
        • pyicat_plus.tests.test_url_utils.test_normlize_url
      • pyicat_plus.tests.utils
        • pyicat_plus.tests.utils.compare
        • pyicat_plus.tests.utils.generate
    • pyicat_plus.utils
      • pyicat_plus.utils.html_utils
        • pyicat_plus.utils.html_utils.HtmlPage
      • pyicat_plus.utils.log_utils
        • pyicat_plus.utils.log_utils.basic_config
      • pyicat_plus.utils.maxsizedict
        • pyicat_plus.utils.maxsizedict.MaxSizeDict
      • pyicat_plus.utils.path_utils
        • pyicat_plus.utils.path_utils.basename
        • pyicat_plus.utils.path_utils.dirname
        • pyicat_plus.utils.path_utils.markdir
        • pyicat_plus.utils.path_utils.split
      • pyicat_plus.utils.raw_data
        • pyicat_plus.utils.raw_data.get_dataset_filters
        • pyicat_plus.utils.raw_data.get_raw_data_dir
        • pyicat_plus.utils.raw_data.get_raw_dataset_metadata
        • pyicat_plus.utils.raw_data.get_raw_dataset_name
        • pyicat_plus.utils.raw_data.get_session_dir
        • pyicat_plus.utils.raw_data.parse_session_dir
      • pyicat_plus.utils.sync_store
        • pyicat_plus.utils.sync_store.ExperimentalSessionStore
      • pyicat_plus.utils.sync_types
        • pyicat_plus.utils.sync_types.Dataset
        • pyicat_plus.utils.sync_types.ExperimentalSession
        • pyicat_plus.utils.sync_types.IcatInvestigation
      • pyicat_plus.utils.url
        • pyicat_plus.utils.url.normalize_url
  • API documentation
  • pyicat_plus
  • pyicat_plus.metadata

pyicat_plus.metadata#

Modules

definitions

drac_report_builder

namespace_wrapper

nexus

Nexus structure from ICAT metadata

previous

pyicat_plus.errors.IcatMetadataValidationWarning

next

pyicat_plus.metadata.definitions
Show Source

© Copyright 2022-2026, ESRF.

pyicat-plus 2.1.1