orte-clean(1)

✨ NAME ✨

okay so bestie, this is orte-clean from Open MPI — the little cleanup crew that comes through and deals with any stale processes and files that got left behind from your Open MPI jobs 💅

---

🌸 SYNOPSIS 🌸

orte-clean [--verbose]
mpirun --pernode [--host | --hostfile file] orte-clean [--verbose]

---

💖 OPTIONS 💖

• -v | --verbose — turn the volume up, queen 🎤 this makes the command run in verbose mode, so it prints out all the universes that are getting cleaned up and all the processes that are getting killed. full play-by-play, no mystery.

---

🦋 DESCRIPTION 🦋

So orte-clean is out here trying to clean up any processes and files left over from Open MPI jobs you ran in the past, plus anything from jobs that are currently running. that includes:

• OMPI infrastructure and helper commands
• any processes that were spawned as part of the job
• any temporary files

and here's the important part, bestie — orte-clean will only act upon processes and files that belong to the user running the orte-clean command. it's not out here touching other people's stuff. 🙈

but if you run it as root, it will kill off processes belonging to any users. root said "no boundaries today" 💀

When you run it straight from the command line, orte-clean attempts to clean up the local node it's run from. When you launch it via mpirun, it cleans up the nodes that mpirun selected. simple as that, no cap.

---

🎀 EXAMPLES 🎀

Example 1: clean up the local node only 🏠

example% orte-clean

Example 2: cleaning up a specific set of nodes ✨

To clean up on a specific set of nodes specified on the command line, it's recommended to use the pernode option — that runs one orte-clean for each node. one for you, one for you, one for you 🫶

example% mpirun --pernode --host node1,node2,node3 orte-clean

And to clean up on a specific set of nodes from a file:

example% mpirun --pernode --hostfile nodes_file orte-clean

Example 3: living inside a resource managed environment 👑

Within a resource managed environment like N1GE, SLURM, or Torque. The following example is from N1GE.

First, we see that we have two nodes with two CPUs each.

example% qsh -pe orte 4
example% mpirun -np 4 hostname
node1
node1
node2
node2

Clean up all the nodes in the cluster.

example% mpirun --pernode orte-clean

Clean up a subset of the nodes in the cluster.

example% mpirun --pernode --host node1 orte-clean

---

🌈 SEE ALSO 🌈

orterun(1), orte-ps(1)

---

and that's the whole vibe, bestie 🎀 this was Open MPI 4.1.6, dated Sep 30, 2023 — go forth and clean up your mess, it's giving responsible main character energy 👑✨