CODE_SATURNE(1)

✨ NAME ✨

okay so code_saturne — it's literally the main user script of Code_Saturne 💅 that's it, that's the whole vibe. this is the girl you call when you wanna do anything.

---

🌸 SYNOPSIS 🌸

code_saturne [-h|--help] <command>

---

🦋 DESCRIPTION 🦋

bestie. listen. the code_saturne script is the main user script of Code_Saturne, fr fr. it's the front door, the group chat admin, the one who knows everybody. you don't knock on the other doors, you knock on this one 💖

---

🎀 OPTIONS 🎀

• -h, --help — shows you the help message. that's it, that's the whole job, and honestly? iconic.

---

👑 COMMANDS 👑

want the tea on any of these? run code_saturne <command> --help and it'll spill everything 🫖✨

• studymanager — the code_saturne studymanager command runs an autovalidation series of runs, and those runs are defined by an xml file. (peep the specific autovalidation documentation for the deets, iykyk.)
• compile — the code_saturne compile command generates the cs_solver executable, which is what you need to actually run a Code_Saturne study. no cs_solver, no slay.
• config — the code_saturne config command gives you info about the Code_Saturne build and installation. like a little "who am i, where am i from" moment for your install 🌈
• create — the code_saturne create command sets up a directory structure for a Code_Saturne study or case. and the directories it creates are: MESH for meshes, POST for user post-processing, and a case directory (or several of them!) containing a DATA, SRC (where your user files live), RESU (where results go) and SCRIPTS directory. it's giving organized 💅
• gui — the code_saturne gui command starts the Code_Saturne gui. yes bestie, a whole graphical interface, treat yourself 💖
• info — the code_saturne info command is a wrapper that makes looking at Code_Saturne documentation easier. a little shortcut, a little convenience, we love her.
• run — the code_saturne run command starts a Code_Saturne case's preprocessing or computation execution. this is the one that actually does the thing 🔥
• salome — the code_saturne salome command starts SALOME with the CFDSTUDY module enabled — assuming Code_Saturne was built with SALOME support. (so like... only if you have the support. don't come for me if you don't 🙈)

---

🌟 ENVIRONMENT VARIABLES 🌟

these ones below can affect code_saturne run:

💜 CS_MPIEXEC_OPTIONS

this variable lets you define extra arguments to pass to the MPI execution command, when applicable. and here's the important part: if this option is defined, it takes priority over the value defined in the global or local code_saturne.cfg files (or over the computed defaults). so basically, if you need to, you can set a setting that's specific to one given run using this variable 👑

💜 CS_SCRATCHDIR

this one lets you define the execution directory, overriding the default path or the settings from the global or local code_saturne.cfg files. she said "not today, defaults" ✨

---

💖 SEE ALSO 💖

the full documentation for Code_Saturne is accessible using the code_saturne info command. go read it, it's free and it's cute 🎀

---

okay that's the whole page bestie!! this was the Code_Saturne commands manual, page CODE_SATURNE(1), dated 2013-07-15 — vintage but still serving 💅 go compile something and make me proud 🫶✨