For every created beamtime and commissiong run, a metadata file will be included in the root directory. It contains some metadata information, which has been extracted from DOOR.
This can be used for additional automation.
Before January 2020, this was a pseudo JSON file. As of January 2020, it is a valid JSON file.
Changelog
- 2022-02-09
- New retentionPeriod key. Indicates the retention period for the data on GPFS as retrieved from DOOR. Currently, this can be either "default" or "onsite".
- 2021-10-27
- New asapo key
- Moved & renamed onlineAnalysis.asapoBeamtimeClbtTokenPath/asapoBeamtimeTokenPath
-> asapo.beamtimeTokenPath/beamtimeClbtTokenPath
Example Beamtime Metadata File
beamtime-metadata-123456789.json
{
"applicant": { # Applicant of the information, with additional information
"email": "max.mustermann@desy.de",
"institute": "Example Institute",
"lastname": "Mustermann",
"userId": "42", # User ID from DOOR, this is not a numerical DESY account UID
"username": "musterma" # Account name from DOOR
},
"asapo": { # Optional: Beamtime related ASAP::O information
"beamtimeClbtTokenPath": "shared/asapo-token-clbt.txt" # Relative path to the read-only token file for ASAP::O
"beamtimeTokenPath": "shared/asapo-token.txt", # Relative path to the read/write token file for ASAP::O
"endpoint": "asapo-ps-0.desy.de:8400" # Endpoint
},
"beamline": "p00", # Name of the beamline, as it will appear in filesystem paths
"beamlineAlias": "P00", # Name of the beamline as provided by DOOR
"beamlineSetup": "Nanoprobe", #
"beamtimeId": "12345678", # ID the of beamtime, also known as application ID
"contact": "Doe",
"corePath": "/asap3/petra3/gpfs/p00/2020/data/12345678", # Path to the beamtime on the core filesystem
"eventEnd": "2020-05-21 09:00:00", # Scheduled end of beamtime from DOOR
"eventStart": "2020-05-15 09:00:00", # Scheduled start of beamtime from DOOR
"facility": "PETRA III", # Name of the facility as provided by DOOR
"generated": "2020-06-12 08:54:05", # Timestamp, when the metadata file has been generated
"leader": { # Leader information, as provided from DOOR
"email": "john.doe@example.org",
"institute": "Example Institure",
"lastname": "Doe",
"userId": "73",
"username": "doejoe"
},
"onlineAnalysis": { # Optional: Information for online analysis related information on the Maxwell compute cluster
"reservedNodes": [ # Array of node names, which have been reserved for this specific beamtime
"max-wn999"
],
"slurmReservation": "12345678_prep", # Name of the reservation in SLURM
"slurmPartition": "ponline", # Name of the partition in SLURM
"sshPrivateKeyPath": "shared/id_rsa", # Relative path to the SSH private key to login to the reserved Maxwell node(s)
"sshPublicKeyPath": "shared/id_rsa.pub",
"userAccount": "bttest03" # Account name, which has to be used for online Analysis
},
"pi": { # Principal investigator information, as provided by DOOR
"email": "max.mustermann@desy.de",
"institute": "Example Institute",
"lastname": "Mustermann",
"userId": "42",
"username": "musterma"
},
"proposalId": "99999999", # ID of the proposal, as provided by DOOR
"proposalType": "I", # Type of the proposal, e.g. "E" for external beamtime or "P" for industrial beamtimes
"retentionPeriod": "default", # The retention period for the data on GPFS as retrieved from DOOR. Currently, either "default" or "onsite".
"title": "Beamtime title", # Title of the proposal, as provided by DOOR
"unixId": "None",
"users": {
"doorDb": [
"musterma",
"doejoe"
],
"special": [],
"unknown": []
}
}
Example Commissioning Metadata File
commissioning-metadata-c20230425_005_mytag.json
{
"beamline": "p00", # Name of the beamline, as it will appear in filesystem paths
"corePath": "/asap3/petra3/gpfs/p00/2023/commissioning/c20230425_005_mytag", # Path to the beamtime on the core filesystem
"generated": "2023-04-25 10:23:13",
"id": "c20230425_005_mytag", # Unique ID of the commissioning run
"onlineAnalysis": { # Optional: Information for online analysis related information on the Maxwell compute cluster
"reservedNodes": [ # Array of node names, which have been reserved for this specific commissioning
"max-wn999"
],
"slurmPartition": "pcommissioning", # Name of the partition in SLURM
"slurmReservation": "c20230425_005_mytag", # Name of the reservation in SLURM
"sshPrivateKeyPath": "shared/id_rsa", # Relative path to the SSH private key to login to the reserved Maxwell node(s)
"sshPublicKeyPath": "shared/id_rsa.pub",
"userAccount": "bttest03" # Account name, which has to be used for online Analysis
},
"tag": "mytag"
}