NDL-CALC(1)

💖 NDL() — ndl calc 💖

okay bestie, sit down, hydrate, and let me tell you about the NDL manual page, because this one is lowkey a whole vibe. 🦋

✨ COMMAND 'ndl calc' ✨

🌸 usage 🌸

usage: ndl calc [-h] [-q] [-d]
[--exclude EXCLUDE] [--include INCLUDE]
[--exclude-metrics MEXCLUDE]
[--include-metrics MINCLUDE] [-f FUNCS]

       [--list-funcs] [--list-metrics]
[respath]

so basically ndl calc calculates various summary functions for an ndl test result — like, imagine you wanna know the median value for one of the CSV columns, that's literally the whole point. no cap. 💅

🎀 respath

• respath — the ndl test result path you wanna calculate summary functions for. that's it, that's the assignment. 🫶

✨ OPTIONS 'ndl calc' ✨

• -h — show this help message and exit. classic. iconic. we love a -h. 👑
• -q — be quiet. 🤫 not a peep.
• -d — print debugging information. for when you're nosy and you need the tea. 🍓
• --exclude EXCLUDE — datapoints to exclude: this removes all the datapoints satisfying the expression EXCLUDE. here's an example expression for you:

(WakeLatency < 10000) | (PC6% < 1)

this filter expression will remove all datapoints with WakeLatency smaller than 10000 nanoseconds or package C6 residency smaller than 1%. the detailed expression syntax lives in the documentation for the eval() function of the Python pandas module, so go read that if you want the full lore. 📖 you can use metrics in the expression, or the special word index for the row number (0-based index) of a datapoint in the results. for example, the expression index >= 10 will get rid of all datapoints except for the first 10 ones. slay. ✨

• --include INCLUDE — datapoints to include: this removes all datapoints except for those satisfying the expression INCLUDE. in other words, this option is the inverse of --exclude. which means --include expr is the same as --exclude "not (expr)". math is math. 🔥
• --exclude-metrics MEXCLUDE — the metrics to exclude. expects a comma-separated list of the metrics, or python style regular expressions matching the names. for example, the expression SilentTime,WarmupDelay,.*Cyc would remove metrics SilentTime, WarmupDelay and all metrics with Cyc in their name. use --list-metrics to get the list of the available metrics. iykyk. 💜
• --include-metrics MINCLUDE — the metrics to include: this removes all metrics except for those specified by this option. the syntax is the same as for --exclude-metrics. twin behavior fr fr. 🧚
• -f FUNCS, --funcs FUNCS — comma-separated list of summary functions to calculate. by default all generally interesting functions are calculated (each metric is associated with a list of functions that make sense for that metric). use --list-funcs to get the list of supported functions. ✨
• --list-funcs — print the list of the available summary functions. window shopping but for functions. 🎀
• --list-metrics — print the list of the available metrics and exit. short, sweet, done. 💅

lowkey reminder bestie: --include is literally just --exclude with a not thrown in there. don't overthink it. 💖

and that's the whole page, no crumbs left. this lil masterpiece is brought to you by NDL() and it's dated 2024-03-08 — go forth and calculate those summary functions, you absolute main character. 👑🌸💜