IPCLUSTER(1)

💖 IPCLUSTER 💖

okay bestie, gather round, because this is the ipcluster manual page from User Commands and it's literally about to make parallel computing your whole personality. ✨

---

🌸 NAME 🌸

ipcluster — start an IPython cluster 🫶

---

✨ DESCRIPTION ✨

Start an IPython cluster for parallel computing. no cap, that's the whole vibe.

So here's the tea: an IPython cluster is made of 1 controller and 1 or more engines. This command is the girlboss that automates starting all of those processes up, and it does it with a wide range of startup methods — we're talking SSH, local processes, PBS, mpiexec, SGE, LSF, HTCondor, Slurm, and Windows HPC Server 2008. iconic range, honestly. 💅

Wanna start a cluster with 4 engines on your local host? Just do this, it's giving effortless:

ipcluster start --n=4

For more complex usage you'll typically do this first:

ipython profile create mycluster --parallel

...then edit the configuration files, and then:

ipcluster start --profile=mycluster --n=4

that's the full glow-up pipeline, bestie. 🌈

🎀 Subcommands 🎀

Subcommands are launched as ipcluster cmd [args]. Wanna know how to use subcommand cmd? Do ipcluster cmd -h. easy.

---

👑 start 👑

Start an IPython cluster for parallel computing

Start an ipython cluster by its profile name or cluster directory. Cluster directories contain configuration, log and security related files, and they're named using the convention profile_<name> — and they should be creating using the start subcommand of ipcluster. (yes, "creating", that's the original's grammar, we don't gatekeep 🫶)

If your cluster directory is in the cwd or the ipython directory, you can simply refer to it using its profile name, like ipcluster start --n=4 --profile=<profile>. Otherwise, use the profile-dir option. simple as. 💅

---

🛑 stop 🛑

Stop a running IPython cluster

Stop a running ipython cluster by its profile name or cluster directory. Cluster directories are named using the convention profile_<name>. If your cluster directory is in the cwd or the ipython directory, you can simply refer to it using its profile name, like ipcluster stop --profile=<profile>. Otherwise, use the --profile-dir option. periodt. ✨

---

⚙️ engines ⚙️

Start engines connected to an existing IPython cluster

Start one or more engines to connect to an existing Cluster by profile name or cluster directory. Cluster directories contain configuration, log and security related files and are named using the convention profile_<name> — and again, should be creating using the start subcommand of ipcluster.

If your cluster directory is in the cwd or the ipython directory, you can simply refer to it using its profile name, like ipcluster engines --n=4 --profile=<profile>. Otherwise, use the profile-dir option. we love a consistent queen. 👑

---

🧩 nbextension 🧩

Enable/disable IPython clusters tab in Jupyter notebook

for Jupyter Notebook >= 4.2, you can use the new nbextension API:

jupyter serverextension enable --py ipyparallel
jupyter nbextension install --py ipyparallel
jupyter nbextension enable --py ipyparallel

okay so that's the trio, write them down. 📝

---

💜 To see all available configurables, use --help-all. go peek bestie, there's lore in there.

---

🌟 EXAMPLES 🌟

here's the greatest hits, fr fr:

ipcluster start --n=4 # start a 4 node cluster on localhost

ipcluster start -h    # show the help string for the start subcmd

ipcluster stop -h     # show the help string for the stop subcmd

ipcluster engines -h  # show the help string for the engines subcmd

main character energy from every single one of these. 🔥

---

okay that's the whole page, and this was ipcluster 6.2.4, dated September 2020 — ty bestie, mwah, go start a cluster and slay 💖✨🎀🦋🌸💅🫶👑🌈⭐