BPLS.SERIAL(1)

✨ NAME ✨

bpls.serial — literally the ADIOS2 utility bestie 💖

---

🎀 DESCRIPTION 🎀

okay so here's the vibe, the usage is:

bpls [OPTIONS] file [mask1 mask2 ...]

It lists / dumps the content of a BP/HDF5 file. 🦋 And a mask can be a shell pattern, just like with ls, e.g. "*/x?". Also real talk: variables that have multiple timesteps get reported with an extra dimension — and the time dimension is the first dimension then. no cap.

Here are all the options, and yes I'm giving you every single one because we don't gatekeep here 👑

• --long, -l — prints values of all scalars and attributes, plus min/max values of arrays (and there's literally no overhead to get them!!)
• --attrs, -a — list/match attributes too
• --attrsonly, -A — list attributes only
• --meshes, -m — list meshes
• --timestep, -t — read content step by step (stream reading)
• --ignore_flatten — displays steps as written (doesn't flatten, even if the writer said to)
• --dump, -d — dump matched variables/attributes. To match attributes too, add option -a
• --regexp, -e — treats masks as extended regular expressions
• --output, -o <path> — print to a file instead of stdout
• --start, -s "spec" — offset indices in each dimension (default is 0 for all dimensions); <0 is handled as in python (-1 is last)
• --count, -c "spec" — number of elements in each dimension; -1 denotes 'until end' of dimension (default is -1 for all dimensions)
• --noindex, -y — print data without array indices
• --string, -S — print 8bit integer arrays as strings
• --columns, -n "cols" — number of data elements per row to print
• --format, -f "str" — format string to use for one data item in print instead of the default. E.g. "%6.3f"
• --hidden_attrs — show hidden ADIOS attributes in the file
• --decomp, -D — show decomposition of variables as layed out in file
• --error, -X string — specify read accuracy (error,norm,rel|abs) e.g. error="0.0,0.0,abs" L2 norm = 0.0, Linf = inf
• --transport-parameters, -T — specify File transport parameters e.g. "Library=stdio"
• --engine, -E <name> — specify ADIOS Engine
• --engine-params, -P string — specify ADIOS Engine Parameters e.g. "SelectSteps=0:n:2"

---

🌸 Examples for slicing 🌸

bestie these are the moment, watch:

-s "0,0,0"   -c "1,99,1":  Print 100 elements (of the 2nd dimension).
-s "0,0"     -c "1,-1":    Print the whole 2nd dimension however large it is.
-s "-1,-1"   -c "1,1":     Print the very last element (of a 2D array)

---

🌈 Help options 🌈

• --help, -h — print this help.
• --verbose, -v — print log about what this program is doing. Use multiple -v to increase logging level.
• --version, -V — print version information; compatible with --verbose for additional information, i.e. -v --version.

---

💅 Typical use

bpls -lav <file>

---

and that's the whole page, you ate that 💜

okay so the tea at the bottom of the page: this whole thing is brought to you by ADIOS, and it's dated September 2024. periodt. 🎀🦋✨