Skip to main content

CLI tool for triggering datacenter metadata updates

Project description

dmtri

Run Tests Coverage

dmtri is a command-line tool designed to trigger metadata and data refresh simulations across EIDA nodes using Ansible automation.


  • seedpsd
  • wfcatalog
  • availability

It uses .dmtri_jobs.json per host to track async job state and integrates with uv and ansible for CLI automation.


Installation & Setup

1. Install or Run

You can run dmtri directly or install it as a tool:

Run without installing (via uvx)

uvx dmtri <command>

Install as a global tool

# Using uv (recommended)
uv tool install dmtri

# Using pip
pip install dmtri

2. Configure

Once installed, set up your local configuration directory:

dmtri init

This creates a config folder (e.g., ~/.config/dmtri/ on Linux) with a template hosts.ini and all standard playbooks.

Edit your Inventory

Use nano (or any text editor) to fill in your EIDA server details:

nano ~/.config/dmtri/hosts.ini

Verify Connectivity

Check if your servers are reachable:

dmtri doctor

Usage

Run Refresh Jobs

Trigger refresh playbooks across your nodes:

dmtri refresh --network HL --station ATH --starttime 2024-01-01

Track Job Status

Monitor the status of asynchronous jobs:

dmtri track

Fix Inconsistencies

Automatically repair the inconsistencies found in an eida-consistency report. A report lists streams where the availability view and dataselect disagree; dmtri fix reads that report and, for each affected stream, re-runs the WFCatalog collector and rebuilds the availability view for the exact time window.

Point it at a report file or URL:

dmtri fix https://eida-oculus.orfeus-eu.org/consistency/NOA/2026/NOA_2026-06-07_140510.json

Fix only specific entries from the report (by their index):

dmtri fix report.json --index 2 --index 16

After a fix, the availability service keeps cached answers for ~20 minutes, so a stream may still look unfixed for a short while. Re-check once the cache expires — this only verifies, it changes nothing:

dmtri fix --verify-only report.json

Prerequisite: the eida-consistency CLI

dmtri fix reads the report through eida-consistency (version 0.5.1 or newer, for its explore --json output). If it isn't already on the machine, install it any one of these ways:

uv tool install eida-consistency     # recommended — puts it on your PATH
pipx install eida-consistency
pip install eida-consistency

You don't strictly have to install it: if uv is present, dmtri fix will run it on demand via uvx eida-consistency. And if it's installed somewhere off your PATH, point dmtri at it:

export DMTRI_EIDA_CONSISTENCY='/full/path/to/eida-consistency'

If it's missing (or too old), dmtri fix stops before touching anything and prints the exact install/upgrade command to run.


Customization

Local Playbooks

dmtri init copies all playbooks to your config directory. You can edit them to change automation logic:

# Location: ~/.config/dmtri/playbooks/
nano ~/.config/dmtri/playbooks/refresh/availability_refresh.yml

dmtri prioritizes these local playbooks over the bundled defaults.

Inventory Overrides

Override the inventory at runtime:

dmtri doctor --inventory ./my_custom_hosts.ini

Operation Details

dmtri supports two main operations for both metadata and data: refresh and clean. These affect the following components:

🔄 Refresh

  • Metadata

    • seedpsd: Scans for new metadata.
    • availability: Refreshes the view in MongoDB.
  • Data

    • Identifies data files in the archive for the specified epoch (by NSLC and time range).
      • seedpsd: Recalculates seedPSD for new files.
      • wfcatalog: Runs the collector on new data files.

🧹 Clean

  • Metadata

    • seedpsd: Removes the metadata entries.
    • availability: Refreshes the view in MongoDB.
  • Data

    • Identifies data files in the archive for the specified epoch.
      • seedpsd: Removes associated seedPSD data (via CLI).
      • wfcatalog: Removes files using the --delete option in the collector.

License

Copyright © 2026 EIDA (European Integrated Data Archive).

dmtri is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dmtri-0.1.4.tar.gz (87.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dmtri-0.1.4-py3-none-any.whl (90.4 kB view details)

Uploaded Python 3

File details

Details for the file dmtri-0.1.4.tar.gz.

File metadata

  • Download URL: dmtri-0.1.4.tar.gz
  • Upload date:
  • Size: 87.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for dmtri-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1cb4d27204390b7afa490ad4a94992e8e72f39406207aaa42709d3439dac5bec
MD5 9601c1a0996cc6e3c02c22704a9a7116
BLAKE2b-256 49ab02f0abf5c8c462696f9bd99d7b169656d92f9acbf87f57c704df763463fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for dmtri-0.1.4.tar.gz:

Publisher: publish.yml on EIDA/dmtri

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dmtri-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: dmtri-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 90.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for dmtri-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d4da28ac59b721e39cf3df7fa5459abfd1d8aba31d9aff92139aeae6c4e6e58f
MD5 b7f7c642f87535d18f930a913ca10c30
BLAKE2b-256 854a327177fc173a09649ef96f439fe0ac2459f4aedfc965a919c5ec815f1655

See more details on using hashes here.

Provenance

The following attestation bundles were made for dmtri-0.1.4-py3-none-any.whl:

Publisher: publish.yml on EIDA/dmtri

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page