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
// TODO: uncomment when docs are somewhat mature to check for missing docs
// #![warn(missing_docs)]
// #![warn(missing_docs_in_private_items)]
//! Crate containing models for second-by-second fuel and energy consumption of simulation
//! of locomotive consists comprising collections of individual locomotives, which comprise
//! various powertrain components (engine, generator/alternator, battery, and electric drivetrain)
//! -- all connected to a detailed train model.
//!
//! # Helpful Tips
//! Nearly struct in this crate implements methods for serializing/deserializing itself to/from a
//! handful of standard data formats as strings or file read/write operations using
//! [traits::SerdeAPI].
//!
//! # Features:
//! - pyo3: enable this feature to expose ALTRIOS structs, methods, and functions to Python