gmk_hy(1)

📦
version 7.0.17 · 2 versions
, in arch rolling, nixpkgs unstable, ubuntu stonking

🌸 gmk_hy — Scotch user's manual, bestie edition 🌸

okay so ✨ welcome to gmk_hy(1) ✨, one of the little graph-maker besties from the Scotch user's manual. She comes with three sisters and together they're the source graph creation squad 💅

🦋 NAME 🦋

gmk_hy, gmk_m2, gmk_m3, gmk_ub2 — they make source graphs, that's the whole vibe 🎀

🌈 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

✨ DESCRIPTION ✨

The gmk_* girlies create source graph files for a few common, regular topologies. Like, if your topology is a known shape, don't hand-build it, that's not the moment 💀

  • gmk_hy — creates a hypercube of dimension dim. cube but make it dimensions.
  • gmk_m2 — creates a 2D regular grid with dimensions dimX and dimY.
  • gmk_m3 — creates a 3D regular grid with dimensions dimX, dimY and dimZ.
  • gmk_ub2 — creates an unoriented de Bruijn graph of dimension dim. yes that's a whole real thing and yes it eats.

💖 OPTIONS 💖

  • -b base — for gmk_m2 and gmk_m3 only, bestie, don't try it on the others. Output graphs with the base value set to base. The default value is 0.
  • -e — for gmk_m2 only. Builds an 8-neighbor grid instead of the usual 4-neighbor grid. more friends, more edges, periodt ✨
  • -gcfile — for gmk_m2 and gmk_m3 only. Outputs the graph vertex coordinates (that's the geometry data, the stuff gout(1) consumes) into file cfile. your geometry, but make it a file 🎀
  • -h — display some help. she's helpful like that 🫶
  • -t — for gmk_m2 and gmk_m3 only. Creates torus graphs 👑 that is, graphs such that there exist loop edges between vertices of rank 0 and (dim-1) in every dimension. wrap-around queen energy, no cap.
  • -V — display program version and copyright. gotta know which era of her you're on 💅

🌸 EXAMPLE 🌸

Create a 5x7 grid along with its geometry, iconic honestly:

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

🧚 SEE ALSO 🧚

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

Scotch user's manual. (the source of all this lore, iykyk)

💜 AUTHOR 💜

Francois Pellegrini <francois.pellegrini@labri.fr>

lowkey the most important thing: every flag, every default, every file path stays exactly the way it was written. vibes are mine, facts are hers. don't come for me 💅

okay bestie that's a wrap 🫶 this was Scotch user's manual energy, documented on 16 June 2026, and her name is still gmk_hy(1), always. slay, bye 💖✨🎀

📦 where this page comes from