fastiron_stats/
lib.rs

1//! Statistical Analysis of [Fastiron]
2//!
3//! This tool is documented to ease future modifications of the code.
4//! The program can be run like any other cargo projects:
5//!
6//! ```shell
7//! cargo run --release --bin=fastiron-stats
8//! ```
9//!
10//! This will print out the command line help message:
11//!
12//! ```shell
13//! fastiron-stats, a profiling companion for Fastiron
14//!
15//! Usage: fastiron-stats [OPTIONS]
16//!
17//! Options:
18//!   -T, --timers-comparison <COMPARISON> <COMPARISON>
19//!           name of the two timers report files to compare - old report first, new report second
20//!   -E, --event-correlation <CORRELATION>
21//!           name of the tallies file to analyze
22//!   -W, --weak-scaling <WEAK_SCALING_ROOT>
23//!           root path of timers file for weak scaling data
24//!   -S, --strong-scaling <STRONG_SCALING_ROOT>
25//!           root path of timers file for strong scaling data
26//!   -t, --thread_init_n <T_INIT>
27//!           starting number of threads for scaling data
28//!   -i, --thread_iter_n <T_ITER>
29//!           starting number of threads for scaling data
30//!   -f, --thread_step_factor <T_FACTOR>
31//!           starting number of threads for scaling data
32//!   -p, --plot
33//!           if present, plot the results of all computed metrics
34//!   -h, --help
35//!           Print help
36//!   -V, --version
37//!           Print version
38//! ```
39//!
40//! [Fastiron]: https://github.com/cea-hpc/fastiron
41
42pub mod command_line;
43pub mod structures;