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

// This needs to be a square logo to avoid stretching, and can have transparency
#![doc(html_logo_url = "https://www.nrel.gov/transportation/assets/images/icon-fastsim.jpg")]
//! Documentation for the Rust backend of the Future Automotive Systems Technology Simulator (FASTSim).

//! # Overview
//! FASTSim provides a simple way to compare powertrains and estimate the impact of technology
//! improvements on light-, medium-, and heavy-duty vehicle efficiency, performance, cost, and battery life.  
//! More information here: <https://www.nrel.gov/transportation/fastsim.html>

//! # Installation
//! Currently, the Rust backend is only available through a Python API.  

//! # Python Examples
//! ```python
//! import fastsim
//!
//! ## Load drive cycle by name
//! cyc_py = fastsim.cycle.Cycle.from_file("udds")
//! cyc_rust = cyc_py.to_rust()
//!
//! ## Load vehicle using database vehicle ID number
//! vnum = 1  
//! veh_py = fastsim.vehicle.Vehicle.from_vehdb(vnum)
//! veh_rust = veh_py.to_rust()
//!
//! ## Simulate
//! sd = fastsim.RustSimDrive(cyc_rust, veh_rust)
//! sd.sim_drive()
//! ```

extern crate ndarray;

#[macro_use]
pub mod macros;
pub mod air;
pub mod cycle;
pub mod imports;
pub mod params;
#[cfg(feature = "pyo3")]
pub mod pyo3imports;
pub mod simdrive;
pub use simdrive::simdrive_impl;
pub mod simdrivelabel;
pub mod thermal;
pub mod traits;
pub mod utils;
pub mod vehicle;
pub mod vehicle_thermal;
pub mod vehicle_utils;

#[cfg(feature = "dev-proc-macros")]
pub use dev_proc_macros as proc_macros;
#[cfg(not(feature = "dev-proc-macros"))]
pub use fastsim_proc_macros as proc_macros;