Skip to main content

dqrxfer

PyPI version Python versions License: GPL v3 Docs

Utility to transfer Data Quality Report (DQR) results from remote sites to the central site.

Overview

dqrxfer is a client-side package used by DQRbuild nodes (e.g., LLO, LHO, Virgo, KAGRA, etc.) to push Data Quality Report files to a central DQRbuild node. It supports both HTTPS (with Shibboleth/ECP authentication) and SCP/SSH transfer methods.

Requirements

  • A valid Kerberos ticket (TGT) or keytab for authentication
  • Network access to the DQRbuild node

Installation

pip install dqrxfer

Commands

The package provides three command-line tools:

dqr-ping

Tests connectivity and authentication with the DQR server. Useful for verifying your Kerberos credentials and network access before attempting an upload.

usage: dqr-ping [-h] [-v] [-V] [-q] [--server SERVER] [--user USER]

Example:

$ dqr-ping
OK
INFO:dqr-xfer:Login: 1.33, Ping: 0.30, status:200
OK
INFO:dqr-xfer:Login: 1.33, Ping: 0.27, status:200
OK
INFO:dqr-xfer:Login: 1.33, Ping: 0.27, status:200
INFO:dqr-xfer:Success = 100.0%
INFO:dqr-xfer:Elapsed time: 2.7s

dqr-upload

Uploads files or directories for a single DQR event to the central site. Supports both SCP (default) and HTTPS transfer.

usage: dqr-upload [-h] [-v] [-V] [-q] [-s SERVER] [--port PORT]
                  [--retries RETRIES] [--retry-wait RETRY_WAIT]
                  [-g GRACEID] [-u UPLOADER] [-p PROJECT] [--user USER]
                  [--revision REVISION] [--subdir SUBDIR] [--config CONFIG]
                  [--set-dir SET_DIR] [--use-https] [--upload-path UPLOAD_PATH]
                  [--remote-command REMOTE_COMMAND] [--temp-dir TEMP_DIR]
                  [files ...]

Key arguments:

Argument Description
-g/--graceid Event ID (e.g. S230601a) or GPS time
-u/--uploader Site ID (e.g. LLO, LHO, Virgo, Kagra)
-p/--project Project name (e.g. o4, replay, mdc, personal)
--revision Integer run/revision number (default: 1)
--use-https Use HTTPS upload instead of SCP

dqr-batch-upload

Scans a DQR result directory and calls dqr-upload for each event found within it. Useful for bulk transfers.

usage: dqr-batch-upload [-h] [-v] [-V] [-q] [-d INDIR] [-p PROJECT]
                        [-u UPLOADER] [--set-dir] [-s SERVER] [--test]

Authentication

dqrxfer uses ciecplib for Shibboleth/ECP authentication over HTTPS. For SCP transfers, standard Kerberos credentials are used.

Obtain a Kerberos ticket before running any command:

kinit albert.einstein@LIGO.ORG

If no Kerberos ticket is available, you will see:

klist: No credentials cache found

License

This project is licensed under the GNU General Public License v3.0.

Metadata

Release files for dqrxfer 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dqrxfer 0.3.0
File Size Uploaded
dqrxfer-0.3.0.tar.gz 26.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dqrxfer 0.3.0
File Interpreter ABI Platform
dqrxfer-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 50.5 kB

Release files / dqrxfer-0.3.0.tar.gz

Download URL dqrxfer-0.3.0.tar.gz
Size 26.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d718a984cbc8dc79ebd38bfb72362cc5a2313f773dddd2ec7ce5969eaa1ed1e1
BLAKE2b-256 checksum
How to use checksums
5369a0b8a23286def0b5fa624dea7c48a1478b4698c82b4a85f1d7ceb7b0f4e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.8

Release files / dqrxfer-0.3.0-py3-none-any.whl

Download URL dqrxfer-0.3.0-py3-none-any.whl
Size 24.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1a86675227189f9fde00c1ddb349b8182057476bfa55c5eb92b4da6960b3b019
BLAKE2b-256 checksum
How to use checksums
4edd1daefcef5338f234ce9646ab15d3a3be2d827c323bd8b15bfe48753d284f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.6

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page