pttree(1)

💅 pttree — like, the group-chat recap of your HDF5 file

okay bestie, so pttree(1) — that's a General Commands Manual page for the command pttree. Let's get into it ✨

🌸 NAME 🌸

pttree — prints a quick overview of the contents of PyTables HDF5 files. no cap, that's literally it.

🎀 SYNOPSIS 🎀

pttree [ OPTIONS ] filename[:nodepath]

yes queen, you give it a filename, and if you're feeling extra you can slap a :nodepath on the end too 🫶

🦋 DESCRIPTION 🦋

so pttree is designed to give you a quick overview of the contents of a PyTables HDF5 file — it prints a depth-indented list of nodes, basically the same energy as the output of the Unix tree function. iconic behaviour, honestly.

it can also show you the size</>, shape</> and compression states</> of individual nodes, plus summary info for the whole file. slay.

💀 real talk though — if you want something way more verbose (like, metadata and all that), you want ptdump instead. pttree is the chill version.

✨ OPTIONS ✨

here's the rundown, bestie. a summary of options is included below 📋

• -L MAX_DEPTH, --max-level MAX_DEPTH — the maximum branch depth of the tree to display. and listen: -1 means no limit, so go feral 🌈
• -S SORT_BY, --sort-by SORT_BY — artificially orders the nodes for you. it can be either "size", "name" or "none" — pick your vibe 💅
• --print-size — prints the size of each node/branch. go off 📏
• --no-print-size — the counterpart to that one 🙈
• --print-shape — prints the shape of each node 🔷
• --no-print-shape — yep, the other side of it 🫶
• --print-compression — prints the compression library(level) for each compressed node 🗜️
• --no-print-compression — the off switch for that 💜
• --print-percent — prints the size of each node as a % of the total tree size on disk. percentages?? obsessed 📊
• --no-print-percent — and the counterpart again 😭
• --use-si-units — reports sizes in SI units, where 1 MB == 10^6 B ✨
• --use-binary-units — reports sizes in binary units, where 1 MiB == 2^20 B 🧚
• -h — print help on usage. when in doubt, -h, fr fr 👑

👀 SEE ALSO 👀

• ptdump(1).
• these utilities are documented fully by the PyTables user's manual. iykyk 📚

💖 AUTHOR 💖

this manual page was written by Antonio Valentino <antonio.valentino@tiscali.it>. giving credit where credit is due, as we should 🎀

okay and for the cute lil sign-off: this page is from the General Commands Manual, and it's dated May 15, 2013 — and the command itself is pttree(1), in case you lost the plot somewhere in the middle bestie 😭💖 go read your HDF5 files, you've got this. periodt. ✨🦋🌸