INST.DLR

Inst.dlr is an instrument metadata database which follows the PIDINST schema. The application is a python package which handles transactions with a MongoDB database. Also, it uses FastAPI to create end-points for the user to introduce data or retrieve entries from the database.

A table containing the schema can be found here where fields and their requirements can be found. The schema used in the code is in JSON schema form and is located in the schemas folder. An additional schema is there for API keys. For information on JSON schema, please refer to the documentation.

inst.dlr is ideal for scientists to keep a paper-trail of experiment changes.
This ensures that data can be tied meaningfully to instruments and anomalies in data may be easily identified with a record of instrumentation modification.
Contextualizing instruments within experiments can be fully automated with inst.dlr.

Key Features

• API for machine-to-machine operations for CRUD operations in the DB
• Authentication using API keys (for API access) and Helmholtz AAI (using DLR IdP) for website access
• Supports for searching records in a human-readable way
• Data validation ensures all entries adhere to the schema
• Data may be submitted or retrieved in various formats (JSON, Excel, CSV, etc.)

Requirements

Note: Check the requirements.txt file for the required packages.

• Python >= 3.11
• MongoDB (Needed if running locally, there is a container image used for this)
• Podman (or docker)
• Podman compose (or docker compose)

System requirements

• Podman system requirements and install instructions
• Docker system requirements and install instructions
  • Docker Engine is under a different license than Docker Desktop. See the bottom of this page.
• MongoDB system requirements
• KeyCloak system requirements