altrios_core/
lib.rs

1// #![warn(missing_docs)]
2// #![warn(missing_docs_in_private_items)]
3
4//! Crate containing models for second-by-second fuel and energy consumption of simulation
5//! of locomotive consists comprising collections of individual locomotives, which comprise
6//! various powertrain components (engine, generator/alternator, battery, and electric drivetrain)
7//! -- all connected to a detailed train model including drag, grade, curvature, bearing, and
8//! rolling resistances.  
9//!
10//! # Helpful Tips
11//! Every struct in this crate implements methods for serializing/deserializing itself to/from a
12//! handful of standard data formats as strings or file read/write operations using
13//! [traits::SerdeAPI].   
14//!
15//! # Feature Flags
16#![doc = document_features::document_features!()]
17
18#[macro_use]
19pub mod macros;
20
21#[cfg(test)]
22pub mod testing;
23
24pub mod combo_error;
25pub mod consist;
26pub mod error;
27pub mod imports;
28pub mod lin_search_hint;
29pub mod meet_pass;
30pub mod prelude;
31pub mod si;
32pub mod track;
33pub mod train;
34pub mod traits;
35pub mod uc;
36pub mod utils;
37pub mod validate;
38
39#[cfg(feature = "pyo3")]
40pub mod pyo3;