Skip to main content

gluex_rs/
lib.rs

1//! Unified Rust, Python, and command-line utilities for the `GlueX` experiment.
2//!
3//! The [`GlueX`] session provides typed run, calibration, raw-read, and canonical
4//! [`workflows`] APIs. Shared experiment metadata lives at the crate root;
5//! [`ccdb`] and [`rcdb`] remain available for advanced database-native reads,
6//! [`lumi`] contains histogram result types, and [`generation`] supports laddu/HDDM.
7
8/// Read-only Calibration and Conditions Database access.
9pub mod ccdb;
10/// Command-line entry points shared by the native and Python executables.
11pub mod cli;
12/// Shared experiment metadata, particle definitions, and parsing helpers.
13///
14/// Much of the particle table mirrors external experiment identifiers whose
15/// variant names are their documentation.
16#[allow(
17    missing_docs,
18    clippy::complexity,
19    clippy::nursery,
20    clippy::pedantic,
21    clippy::perf,
22    clippy::style,
23    clippy::suspicious
24)]
25pub mod core;
26/// Backend-neutral errors returned by unified database requests.
27pub mod database;
28/// Cancellation and timeout controls for synchronous evaluation.
29pub mod execution;
30/// Monte Carlo generation and HDDM writing utilities.
31pub mod generation;
32pub use database::{DatabaseError, DatabaseResult};
33pub use execution::{CancellationToken, ExecutionError, ExecutionOptions};
34
35/// I/O for various ``GlueX`` file formats.
36#[allow(
37    clippy::complexity,
38    clippy::nursery,
39    clippy::pedantic,
40    clippy::perf,
41    clippy::style,
42    clippy::suspicious
43)]
44pub mod io;
45
46/// Photon-flux and tagged-luminosity calculations.
47pub mod lumi;
48/// Run Conditions Database access and predicate builders.
49pub mod rcdb;
50
51/// Shared numeric scope and recorded membership queries.
52pub mod runs;
53pub use runs::{
54    CalibrationPath, ConditionCatalog, ConditionDefinition, ConditionOmission, ConditionProvenance,
55    ConditionQuery, ConditionReport, ConditionResults, ConditionStream, ConditionValue,
56    ConditionValueType, MissingDataConfig, MissingDataPolicy, ProcedureStatus, RunAccounting,
57    RunOmission, RunOmissionReason, RunPredicate, RunProvenance, RunQuery, RunReport, RunSelection,
58    RunSet, RunStream, SourceIdentity, Variation,
59};
60
61/// Enforced read-only raw rows and parameters.
62pub mod raw;
63pub use raw::{RawColumn, RawError, RawResults, RawRow, RawValue};
64
65mod session;
66pub use session::{
67    CacheInfo, Capabilities, DatabaseKind, GlueX, GlueXError, SourceConfig, Sources,
68};
69
70/// Canonical GlueX Workflows and retained provenance.
71pub mod workflows;
72pub use workflows::{
73    LUMINOSITY_PROCEDURE_VERSION, LuminosityProvenance, LuminosityQuery, LuminosityReport,
74    LuminosityResult, WorkflowError, Workflows,
75};
76
77#[cfg(feature = "python")]
78#[allow(
79    clippy::complexity,
80    clippy::nursery,
81    clippy::pedantic,
82    clippy::perf,
83    clippy::style,
84    clippy::suspicious
85)]
86mod python;
87
88pub use core::{
89    Charge, DetectorSystem, GlueXCoreError, Histogram, Id, Particle, Polarization, RESTVersion,
90    RESTVersionContext, RESTVersionInfo, RESTVersionSelection, RunNumber, RunPeriod, constants,
91    enums, parsers, particles, run_periods, utils,
92};
93
94/// Typed operands for Condition Predicate construction.
95pub use rcdb::conditions::ConditionOperand;
96
97/// Calibration catalogs and explicit numeric queries.
98pub mod calibrations;
99pub use calibrations::{
100    CalibratedRunPeriod, CalibrationCatalog, CalibrationColumn, CalibrationColumnValues,
101    CalibrationDirectory, CalibrationEntry, CalibrationPayload, CalibrationProvenance,
102    CalibrationQuery, CalibrationReport, CalibrationSeries, CalibrationStream, CalibrationTable,
103    CalibrationTableMetadata, CalibrationValueType, ReconstructionPeriod, ReconstructionSelection,
104};