Skip to main content

Crate gluex_rs

Crate gluex_rs 

Source
Expand description

Unified Rust, Python, and command-line utilities for the GlueX experiment.

The GlueX session provides typed run, calibration, raw-read, and canonical workflows APIs. Shared experiment metadata lives at the crate root; ccdb and rcdb remain available for advanced database-native reads, lumi contains histogram result types, and generation supports laddu/HDDM.

Re-exports§

pub use database::DatabaseError;
pub use database::DatabaseResult;
pub use execution::CancellationToken;
pub use execution::ExecutionError;
pub use execution::ExecutionOptions;
pub use runs::CalibrationPath;
pub use runs::ConditionCatalog;
pub use runs::ConditionDefinition;
pub use runs::ConditionOmission;
pub use runs::ConditionProvenance;
pub use runs::ConditionQuery;
pub use runs::ConditionReport;
pub use runs::ConditionResults;
pub use runs::ConditionStream;
pub use runs::ConditionValue;
pub use runs::ConditionValueType;
pub use runs::MissingDataConfig;
pub use runs::MissingDataPolicy;
pub use runs::ProcedureStatus;
pub use runs::RunAccounting;
pub use runs::RunOmission;
pub use runs::RunOmissionReason;
pub use runs::RunPredicate;
pub use runs::RunProvenance;
pub use runs::RunQuery;
pub use runs::RunReport;
pub use runs::RunSelection;
pub use runs::RunSet;
pub use runs::RunStream;
pub use runs::SourceIdentity;
pub use runs::Variation;
pub use raw::RawColumn;
pub use raw::RawError;
pub use raw::RawResults;
pub use raw::RawRow;
pub use raw::RawValue;
pub use workflows::LUMINOSITY_PROCEDURE_VERSION;
pub use workflows::LuminosityProvenance;
pub use workflows::LuminosityQuery;
pub use workflows::LuminosityReport;
pub use workflows::LuminosityResult;
pub use workflows::WorkflowError;
pub use workflows::Workflows;
pub use core::Charge;
pub use core::DetectorSystem;
pub use core::GlueXCoreError;
pub use core::Id;
pub use core::Particle;
pub use core::Polarization;
pub use core::RESTVersion;
pub use core::RESTVersionContext;
pub use core::RESTVersionInfo;
pub use core::RESTVersionSelection;
pub use core::RunNumber;
pub use core::RunPeriod;
pub use core::constants;
pub use core::enums;
pub use core::parsers;
pub use core::particles;
pub use core::run_periods;
pub use core::utils;
pub use rcdb::conditions::ConditionOperand;
pub use calibrations::CalibratedRunPeriod;
pub use calibrations::CalibrationCatalog;
pub use calibrations::CalibrationColumn;
pub use calibrations::CalibrationColumnValues;
pub use calibrations::CalibrationDirectory;
pub use calibrations::CalibrationEntry;
pub use calibrations::CalibrationPayload;
pub use calibrations::CalibrationProvenance;
pub use calibrations::CalibrationQuery;
pub use calibrations::CalibrationReport;
pub use calibrations::CalibrationSeries;
pub use calibrations::CalibrationStream;
pub use calibrations::CalibrationTable;
pub use calibrations::CalibrationTableMetadata;
pub use calibrations::CalibrationValueType;
pub use calibrations::ReconstructionPeriod;
pub use calibrations::ReconstructionSelection;

Modules§

calibrations
Calibration catalogs and explicit numeric queries. Source-bound calibration discovery and explicit numeric retrieval.
ccdb
Read-only Calibration and Conditions Database access. GlueX CCDB access library with optional Python bindings.
cli
Command-line entry points shared by the native and Python executables. Command-line interface for unified GlueX tools.
core
Shared experiment metadata, particle definitions, and parsing helpers.
database
Backend-neutral errors returned by unified database requests. Backend-neutral errors for source-bound database queries.
execution
Cancellation and timeout controls for synchronous evaluation. Cooperative cancellation and deadlines for synchronous database work.
generation
Monte Carlo generation and HDDM writing utilities.
io
I/O for various GlueX file formats. AmpTools, FSRoot, and Pawian event interchange for laddu datasets.
lumi
Photon-flux and tagged-luminosity calculations. GlueX photon-flux and tagged-luminosity utilities.
raw
Enforced read-only raw rows and parameters. Parameterized, backend-enforced read-only row retrieval.
rcdb
Run Conditions Database access and predicate builders. GlueX RCDB access library with optional Python bindings.
runs
Shared numeric scope and recorded membership queries. Numeric Run Selections and explicitly resolved recorded Run Sets.
workflows
Canonical GlueX Workflows and retained provenance. Canonical GlueX Workflows built on configured database sources.

Structs§

CacheInfo
Inspectable bounds and current occupancy for session-owned metadata caches.
Capabilities
Immutable description of configured database capabilities.
GlueX
A session with independently optional RCDB and CCDB capabilities.
Histogram
A simple weighted histogram with explicit bin edges.
Sources
Database-native access through shared readers.

Enums§

DatabaseKind
A database capability available to a session.
GlueXError
Configuration and missing-capability errors from a session.
SourceConfig
Configuration for one optional database source.