ESRFPath_esrf_v1

class esrf_pathlib.ESRFPath_esrf_v1(*args, **kwargs)

Bases: Path

ESRF Data Policy v1

Introduced with BLISS 1.2.0 for beamline data on Feb 11, 2020.

Path hierarchy:

{data_root}/{proposal}/{beamline}/               [TID]
  └── {session_date}/                            [BLISS]
        ├── {proposal}_{beamline}.h5
        ├── {collection}/
        |     ├── {proposal}_{collection}.h5
        |     └── {dataset}/
        |           └── {collection}_{dataset}.h5
        └── __icat__/
              └── {collection}_{dataset}.xml

Derive a class from ESRFPath to restrict path matching, parsing and rendering to this schema:

from esrf_pathlib import ESRFPath

class EsrfPath(ESRFPath, esrf=1, fallback_depth=0):
    pass

property beamline: str

Beamline name.

Examples: 'id21', 'id23eh1', 'id30a1'

property beamline_normalized: str

Normalized beamline name for the Data Portal.

Examples: 'id21', 'id23-1', 'id30a-1'

property collection: str

Collection identifier grouping datasets.

property data_root: str

Root directory.

property data_type: str

Data type. Fixed to ‘raw’ for this schema.

property dataset: str

Dataset name (smallest entity in the data portal).

property proposal: str

ESRF proposal name.

Examples: 'ma1234', 'blc1234'

property raw_collection_file: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{collection}/{proposal}_{collection}.h5

property raw_collection_path: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{collection}[/{unknown_part}]

property raw_dataset_file: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{collection}/{collection}_{dataset}/{collection}_{dataset}.h5

property raw_dataset_path: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{collection}/{collection}_{dataset}[/{unknown_part}]

property raw_gallery_path: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{collection}/{collection}_{dataset}/gallery[/{unknown_part}]

property raw_metadata_file: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/__icat__/{collection}_{dataset}.xml

property raw_metadata_path: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/__icat__[/{unknown_part}]

property raw_proposal_file: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}/{proposal}_{beamline}.h5

property session_date: date

Start date of the experimental session (YYYYMMDD).

property session_path: str

Filesystem path template

{data_root}/{proposal}/{beamline}/{session_date}[/{unknown_part}]

property unknown_part: str

Unknown path or path segment (placeholder for unmapped directories or files).

property unknown_path: str

Filesystem path template

{unknown_part}