scientific-workflow 0.1.5

Typed scientific states, time series, and chunked workflow storage
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Convenient import of the complete supported end-user API.
//!
//! Importing this module brings every crate-owned public structure, error, and
//! extension trait into scope:
//!
//! ```
//! use scientific_workflow::prelude::*;
//!
//! let time = SimulationTime::from_iteration(0);
//! assert_eq!(time.iteration(), 0);
//! let decoders = JsonPayloadDecoderRegistry::new();
//! assert!(decoders.is_empty());
//! let _: Option<ProjectConfig> = None;
//! ```
//!
//! The prelude is explicit rather than a wildcard re-export of internal
//! modules. General-purpose external traits, including Serde traits, remain the
//! responsibility of the application that uses them.

pub use crate::configuration::{
    ConfigurationError, MatchingTaskConfigIter, ParameterSpace, ProjectConfig, ProjectPaths,
    TaskConfig, TaskConfigIter, TaskParameters, TaskParametersIter,
};
pub use crate::execution::{ExecutionScope, ExecutionScopeError};
pub use crate::project::{ScientificProject, ScientificProjectError};
pub use crate::reporting::{
    ProgressReporter, ProgressReporterBuilder, ProgressSummary, ReportingError, TaskIdentity,
    TaskProgress, TaskStatus,
};
pub use crate::rng_record::{RNG_RECORDS_METADATA_KEY, RngRecord, RngRecordError};
pub use crate::storage::{
    CompletedRecording, CompletedStreamSummary, JsonPayloadDecoder, JsonPayloadDecoderRegistry,
    JsonStringDecoder, JsonVecF64Decoder, RecordingTiming, SamplingInterval, StateStreamConfig,
    StorageError, StoredStateSeriesReader, SystemStateWriter, SystemStateWriterBuilder,
    TimeAxisMetadata,
};
pub use crate::system_state::{
    PayloadInsertError, SimulationTime, StateError, StateFieldSchema, SystemState,
    SystemStateSchema,
};
pub use crate::time_series::{
    StateSeries, StateSeriesError, StateSeriesPushError, StateSeriesView,
};