gmk_hy(1)

💖 gmk_hy 💖

okay bestie, welcome to the Scotch user's manual page for gmk_hy(1) — yes, that's section 1, the real one, we're doing this properly 💅

---

🌈 NAME 🌈

gmk_hy, gmk_m2, gmk_m3, gmk_ub2 — create source graphs. that's it, that's the whole job, they make graphs for you 🫶

---

✨ SYNOPSIS ✨

gmk_hy [options] dim [ofile]

gmk_m2 [options] [-gcfile] dimX dimY [ofile]

gmk_m3 [options] [-gcfile] dimX dimY dimZ [ofile]

gmk_ub2 [options] dim

look at those four little lines just vibing 😌 every single one matters, don't skip any.

---

🦋 DESCRIPTION 🦋

so the gmk_* programs — the whole squad — create source graph files for some common, regular topologies. regular topologies = shapes that repeat nicely, no chaos, very organized, very demure ✨

here's who does what, no cap:

• gmk_hy — creates a hypercube of dimension dim.
• gmk_m2 — creates a 2D regular grid of dimensions dimX and dimY.
• gmk_m3 — creates a 3D regular grid of dimensions dimX, dimY and dimZ.
• gmk_ub2 — creates an unoriented de Bruijn graph of dimension dim.

four besties, four topologies, all iconic 💖

---

🎀 OPTIONS 🎀

the way that every single one of these is here, in order, untouched, periodt:

• -b base — For gmk_m2 and gmk_m3 only. Output graphs with base value set to base. Default value is 0. so if you don't say anything, it's 0, okay? 💅
• -e — For gmk_m2 only. Build a 8-neighbor grid rather than a 4-neighbor grid. more neighbors more friends 🫶
• -gcfile — For gmk_m2 and gmk_m3 only. Output graph vertex coordinates (that is, geometry data to be used by gout(1)) in file cfile. yesss give gout(1) the geometry it deserves 😭
• -h — Display some help. short, sweet, helpful, a queen 👑
• -t — For gmk_m2 and gmk_m3 only. Create torus graphs, that is, graphs such that there exist loop edges between vertices of rank 0 and (dim-1) in every dimension. donut energy 🍩 loop edges, wrap around, iconic.
• -V — Display program version and copyright.

---

🌸 EXAMPLE 🌸

Create a 5x7 grid along with its geometry:

$ gmk_m2 5 7 -g/tmp/m5x7.xyz /tmp/m5x7.grf

not me writing this exact command and it just working 💀✨ copy it character for character bestie, don't freestyle.

---

💜 SEE ALSO 💜

gbase(1), gmk_msh(1), gtst(1), gmap(1), gord(1), gout(1), amk_grf(1).

Scotch user's manual.

go read those too, they're all in the same friend group 🌈

---

👑 AUTHOR 👑

Francois Pellegrini <francois.pellegrini@labri.fr>

---

🎀 and that's the whole page, bestie. you ate. no notes. 💅

this masterpiece was served to you by the Scotch user's manual, dated 23 November 2019, and yeah we're still on gmk_hy(1) — iykyk 💖✨🦋