Skip to main content

EIDA consistency checker: compare availability vs dataselect services and generate reports.

Project description

EIDA Consistency Checker

Run Tests Coverage


A tool to evaluate the consistency between EIDA nodes' availability and dataselect web services.
Designed for use in quality control and monitoring tasks across the European Integrated Data Archive (EIDA).


🚀 Installation & Quick Start

You can use eida-consistency in two ways:

Option 1: Using uvx

uvx eida-consistency <command> [options]

Option 2: Global install

uv tool install eida-consistency

Now it’s available globally:

eida-consistency <command> [options]

Update it with:

uv tool upgrade eida-consistency

🔍 CLI Commands

Run Consistency Check

Check if availability spans align with dataselect results:

uvx eida-consistency consistency --node RESIF --epochs 10 --duration 600

Options:

  • --node: Node code (e.g. RESIF, NOA, ETH)
  • --epochs: Number of random test epochs (default: 10)
  • --duration: Epoch length in seconds (≥600)
  • --seed: Reproducible seed
  • --delete-old: Keep only the most recent report
  • --stdout: Print JSON report to stdout
  • --report-dir: Save reports to a custom folder (default: reports/)
  • --log-level: Control verbosity (DEBUG, INFO, WARNING, ERROR)

Compare Reports

Compare results across two runs with the same seed:

uvx eida-consistency compare reports/resif_run1.json reports/resif_run2.json

Explore Inconsistencies

Drill down into inconsistencies with day-by-day exploration:

uvx eida-consistency explore reports/nodes/noa/*.json --index 7 --days 15 --verbose

You can also use:

uvx eida-consistency explore --latest

to automatically use the newest report.

Manage Node List

Reload routing cache:

uvx eida-consistency reload-nodes

List currently cached nodes:

uvx eida-consistency list-nodes

📂 Reports

Reports are stored in ./reports/ by default, or in a custom folder using --report-dir.

  • JSON reports: reports/resif_<seed>.json
  • Markdown reports: reports/resif_<seed>.md
  • Global summary: summary.md

🧪 Example Workflow

1. Run a check for NOA:

uvx eida-consistency consistency --seed 1234 --node NOA --epochs 20 --duration 600 --report-dir reports/test_noa

2. Explore incosistencies:

If inconsistencies are found:

uvx eida-consistency explore reports/nodes/resif/*.json --verbose

3. Apply fixes

Investigate the reported service inconsistencies and fix them at node level. Maybe use dmtri command suggested.

4. Re-run Consistency

uvx eida-consistency consistency --seed 1234 --node NOA --epochs 20 --duration 600 --report-dir reports/test_noa

5.Compare Before/After

uv run eida-consistency compare reports/test_noa/old.json reports/test_noa/new.json

📊 Global Consistency Summary

Node Epochs Requested Epochs Usable Total Checks Consistent Inconsistent Score
BGR 20 20 20 15 5 75.0 %
BGS 20 11 11 6 5 54.55 %
ETH 20 20 20 19 1 95.0 %
GEOFON 20 20 20 20 0 100.0 %
KOERI 20 20 20 10 10 50.0 %
LMU 20 20 20 20 0 100.0 %
NIEP 20 20 20 15 5 75.0 %
NOA 20 20 20 16 4 80.0 %
RESIF 20 20 20 20 0 100.0 %
UIB-NORSAR 20 20 20 18 2 90.0 %

📖 Full details: summary.md


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

eida_consistency-0.3.3.tar.gz (62.4 kB view details)

Uploaded Source

Built Distribution

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

eida_consistency-0.3.3-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

Details for the file eida_consistency-0.3.3.tar.gz.

File metadata

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

File hashes

Hashes for eida_consistency-0.3.3.tar.gz
Algorithm Hash digest
SHA256 63ecb2d95601f10a1d0f217329b4a54de4ccfb19730ae663e679a25365ded842
MD5 575b3d7f72d09ccfc83cbbb6cc4507b7
BLAKE2b-256 0d17d75c521dfdff22a5c52163619670aae190ec1bc07b51cd62190bd2a50a77

See more details on using hashes here.

Provenance

The following attestation bundles were made for eida_consistency-0.3.3.tar.gz:

Publisher: publish.yml on EIDA/eida-consistency

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

File details

Details for the file eida_consistency-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for eida_consistency-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7e915aa21e30e3ad56847bd98553f60ee96b7db69c14693937331533508f31
MD5 5fae9b0ad9d1816022f36780dbc1333d
BLAKE2b-256 b2c496e4f9a9899bbaad66c1bc8d9594b26be159ad7fbd4ad7a4bed1e1399a52

See more details on using hashes here.

Provenance

The following attestation bundles were made for eida_consistency-0.3.3-py3-none-any.whl:

Publisher: publish.yml on EIDA/eida-consistency

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