fastsim-core 1.0.4

Core FASTSim models for vehicle energy usage simulation
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Core crate for performing FASTSim simulations.
//!
//! # Crate Specific Coding Practices
//! - `#[non_exhaustive]` macro is invoked to force any downstream crate to use
//!    the `Init` trait to initialize structs that implement this macro
//! - `#[fastsim_api]` -- used to expose the struct to python and provides assorted other features related to usability

#![allow(clippy::field_reassign_with_default)]
// 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 vehicles
//! # Feature Flags
#![doc = document_features::document_features!()]

#[macro_use]
pub mod macros;

extern crate uom;

pub mod drive_cycle;
pub mod error;
pub mod gas_properties;
pub mod imports;
pub mod prelude;
// #[cfg(feature = "pyo3")] -- feature gate provided inside module
pub mod pyo3;
pub mod si;
pub mod simdrive;
#[cfg(feature = "simdrivelabel")]
pub mod simdrivelabel;
pub mod traits;
pub mod uc;
pub mod utils;
pub mod vehicle;

/// List enabled features
#[cfg_attr(feature = "pyo3", imports::pyfunction)]
pub fn enabled_features() -> Vec<String> {
    vec![
        #[cfg(feature = "default")]
        "default".into(),
        #[cfg(feature = "resources")]
        "resources".into(),
        #[cfg(feature = "web")]
        "web".into(),
        #[cfg(feature = "serde-default")]
        "serde-default".into(),
        #[cfg(feature = "csv")]
        "csv".into(),
        #[cfg(feature = "json")]
        "json".into(),
        #[cfg(feature = "toml")]
        "toml".into(),
        #[cfg(feature = "yaml")]
        "yaml".into(),
    ]
}