WULT-CALC(1)

🦋 WULT-CALC(1) 🦋

okay bestie, sit DOWN, because we're talking about wult calc — it lives in the WULT manual (that's the manual name, she's iconic, no notes), the title is CALC, and this particular page is dated 2024-03-08. yes it's a whole moment. let's go 💅

👑 COMMAND 'wult calc' 👑

the vibe in one line, fr fr:

usage: wult calc [-h] [-q] [-d] [--exclude EXCLUDE] [--include INCLUDE]
[--exclude-metrics MEXCLUDE] [--include-metrics MINCLUDE] [-f FUNCS]
[--list-funcs] [--list-metrics] [respath]

so what does she do? she calculates various summary functions for a wult test result — like, say, the median value for one of the CSV columns. that's it. that's the job. and she eats every single time ✨

🎀 the argument (she's the main character)

• respath — the wult test result path you want to calculate summary functions for. basically, where your results live. point her at it and she goes 🫶

🌸 OPTIONS 'wult calc' 🌸

here come the flags, and yes there are a lot of them, we're listing all of them because we don't skip chapters in this house 💖

• -h — show this help message and exit. the classic. the "hello?? what do I do" button 🙈
• -q — be quiet. shhh. 🤫
• -d — print debugging information. for when you need the tea, all of it 🍓
• --exclude EXCLUDE — datapoints to exclude: this removes all the datapoints satisfying the expression EXCLUDE. here's an example of an expression:

(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 — go read that, bestie, it's giving very much iykyk. 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. bye bye, little rows 👋

• --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)". mirror mirror on the wall 🪞
• --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. regex girlies rise 🌈
• --include-metrics MINCLUDE — the metrics to include: removes all metrics except for those specified by this option. the syntax is the same as for --exclude-metrics. same energy, opposite direction 💜
• -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. defaults said "I got you" and honestly? she did 👑
• --list-funcs — print the list of the available summary functions. window shopping, but for math 🧚
• --list-metrics — print the list of the available metrics and exit. she shows you the menu then dips immediately, queen behaviour ⭐

lowkey important: those --exclude / --include expressions are doing real filtering on your actual datapoints, so if your expression is unhinged, your results will be too. be normal about it, or at least be intentional 💀

and that's the page!! WULT, title CALC, dated 2024-03-08 — that's the source and date situation, consider yourself signed off on, mwah 💖✨🎀🦋🌸💅🫶