---
name: "code_saturne"
section: "1"
platform: "linux"
package: "code-saturne-bin"
version: "6.0.2-2"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/code_saturne"
---

# code\_saturne(1)

Main user script of Code\_Saturne.

## NAME

code\_saturne - Main user script of Code\_Saturne.

## SYNOPSIS

**code\_saturne** \[-h\|--help\] \<command\>\

## DESCRIPTION

The **code\_saturne** script is the main user script of Code\_Saturne.

## OPTIONS

- \-h, --help

  **Help message.**

## COMMANDS

Further information will be obtained with **code\_saturne \<command\> --help**

- studymanager

  **The** **code\_saturne studymanager** command can be used to run an autovalidation series of runs defined by an xml file (see specific autovalidation documentation).

- compile

  **The** **code\_saturne compile** command can be used to generate the **cs\_solver** executable needed for running a Code\_Saturne study.

- config

  **The** **code\_saturne config** command provides information about the Code\_Saturne build and installation.

- create

  **The** **code\_saturne create** command sets up a directory structure for a Code\_Saturne study or case. The different directories created are MESH for meshes, POST for user post-processing and a case directory (or several) containing a DATA, SRC (to store user files), RESU (to store results) and SCRIPTS directory.

- gui

  **The** **code\_saturne gui** command starts the Code\_Saturne gui.

- info

  **The** **code\_saturne info** command is a wrapper for an easier look at Code\_Saturne documentation.

- run

  **The** **code\_saturne run** starts a Code\_Saturne case's preprocessing or computation execution.

- salome

  **The** **code\_saturne salome** command starts SALOME, with the CFDSTUDY module enabled (assuming Code\_Saturne is built with SALOME support).

## ENVIRONMENT VARIABLES

The following environment variables may affect **code\_saturne run :**

- **CS\_MPIEXEC\_OPTIONS**

  This variable allows defining extra arguments to be passed to the MPI execution command when applicable. If this option is defined, it will have priority over the value defined in global or local **code\_saturne.cfg** files (or by computed defaults), so if necessary, it is possible to define a setting specific to a given run using this variable.

- **CS\_SCRATCHDIR**

  Allows defining the execution directory, overriding the default path or settings from the global or local **code\_saturne.cfg** files.

## SEE ALSO

The full documentation for Code\_Saturne is accessible using the **code\_saturne info** command.