hpr_analysis/lib.rs
1//! Monte Carlo dispersion, sensitivity analysis, optimization and challenge specifications.
2//!
3//! **Guide:** [Monte Carlo dispersion][guide-mc] shows a run and how far to trust it;
4//! [Sensitivity analysis][guide-sa] ranks which inputs matter; [Optimization][guide-opt] finds the
5//! design that hits a target; [Start here][guide-start] says what
6//! works today and what is planned.
7//!
8//! [guide-mc]: https://nrdptel.github.io/hpr-sim/monte-carlo.html
9//! [guide-sa]: https://nrdptel.github.io/hpr-sim/sensitivity.html
10//! [guide-opt]: https://nrdptel.github.io/hpr-sim/optimization.html
11//! [guide-start]: https://nrdptel.github.io/hpr-sim/start-here.html
12//! [roadmap]: https://github.com/nrdptel/hpr-sim/blob/main/docs/ROADMAP.md
13//!
14//! - [`montecarlo`]: one rocket flown many times with its uncertain inputs drawn afresh each
15//! time, seeded and reproducible sample by sample, in parallel with the `parallel` feature.
16//! - [`statistics`]: the spread of what the samples gave, with the failed ones counted.
17//! - [`ellipse`]: where the landings scatter, as an ellipse holding a chosen share of them.
18//! - [`sensitivity`]: which uncertain inputs move a result most, by Morris's screening and
19//! Sobol' indices.
20//! - [`optimize`]: the design variables that make a result as small as it can be, by CMA-ES;
21//! to hit a target apogee, say.
22//!
23//! Status: dispersion, the apogee's spread, landing ellipses and sensitivity analysis
24//! (milestones [M6.1a to M6.1c][roadmap] of the roadmap), and optimization over continuous
25//! variables ([M6.2a][roadmap]). Discrete choices, constraints and several objectives are planned
26//! for the rest of [M6.2][roadmap], and challenge specifications for [M6.3][roadmap].
27
28pub mod ellipse;
29mod error;
30pub mod montecarlo;
31pub mod optimize;
32pub mod sensitivity;
33pub mod statistics;
34pub mod table;
35
36pub use error::AnalysisError;