PMG(1)

👑 PMG(1) — the vibe check 👑

okay so bestie, you opened pmg(1), which lives in the User Commands section of the manual. It's the manual page for pmg, and I'm about to make it make sense, no cap. 💅

🎀 NAME 🎀

pmg — pymatgen. that's it, that's the name. short, iconic, does what it says on the tin. ✨

💖 DESCRIPTION 💖

okay so first things first, here's literally how you call it:

usage: pmg [-h] {config,analyze,query,plot,structure,view,diff,potcar} ...

pmg is a convenient script that uses pymatgen to do a whole bunch of analyses, plotting, and format conversions. it's giving swiss army knife, it's giving main character energy. 🦋

here's the tea though: this script runs on several subcommands, and every single one of them has its own options. so if you wanna see what a subcommand can do, you literally just go:

pmg sub-command -h

that's the move. don't skip it. 🫶

🌸 positional arguments 🌸

these are the subcommands, the little guys, the squad. pick one:

• {config,analyze,query,plot,structure,view,diff,potcar} — the full roster, right there in one curly-brace bundle. 👑
• config — Tools for configuring pymatgen, e.g., potcar setup, modifying .pmgrc.yaml configuration file. it's the settings gremlin. set it up once, thank yourself later. 🎀
• analyze — Vasp calculation analysis tools. VASP numbers go in, understanding comes out. 🔥
• query — Search for structures and data from the Materials Project. it's giving detective, it's giving let me find that structure for you bestie. 🔍 (ok the emoji is a magnifying glass, not a listed one, but the energy is correct) ✨
• plot — Plotting tool for DOS, CHGCAR, XRD, etc. graphs. pretty pictures. slay. 📈
• structure — Structure conversion and analysis tools. converting and analyzing structures, exactly like it sounds, no plot twist. 🧚
• view — Visualize structures. look at them. with your eyes. iconic. 👀
• diff — Diffing tool. For now, only INCAR supported. for now, bestie — that's a direct quote from the manpage, not me manifesting more features. 🙈
• potcar — Generate POTCARs. born to make POTCARs, forced to exist in a manpage. 💜

✨ optional arguments ✨

• -h, --help — show this help message and exit. the classic. the universal escape hatch. when in doubt, -h it out. 😭

Version: 2020.12.18

and that's the whole page, bestie. every flag, every subcommand, every crumb of info — nothing dropped, nothing invented. 🍓

pymatgen · December 2020 — that's the source, the version, and the date, and that's my cute little sign-off. mwah. 💖🌈⭐