From 5f747c927a202ec4f9c00b3a5bc7fbc7e7bd03e8 Mon Sep 17 00:00:00 2001 From: Soren Rasmussen Date: Fri, 6 Sep 2024 14:00:34 -0600 Subject: [PATCH] Adding documentation on run_scm.py --mpi_command argument --- scm/doc/TechGuide/chap_quick.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/scm/doc/TechGuide/chap_quick.rst b/scm/doc/TechGuide/chap_quick.rst index df96e0f40..969c1e758 100644 --- a/scm/doc/TechGuide/chap_quick.rst +++ b/scm/doc/TechGuide/chap_quick.rst @@ -594,6 +594,12 @@ If using the main branch, you should run the above command to ensure you have th - Use this to specify the timestep to use (if different than the default specified in ``../src/suite_info.py``). +- ``--mpi_command`` + + - Provide argument to define the MPI command that will be invoked. + Default MPI command is ``mpirun -np 1``. + (Note: to run on a Derecho login node the empty argument ``--mpi_command ''`` is required.) + - ``--verbose [-v]`` - Use this option to see additional debugging output from the run @@ -876,7 +882,7 @@ Running the Docker image #. To run the SCM, you can run the Docker container that was just created and give it the same run commands as discussed in :numref:`Section %s ` - **Be sure to remember to include the ``-d`` and ``--mpi_command "mpirun -np 1 --allow-run-as-root"`` + **Be sure to remember to include the ``-d`` and ``--mpi_command "mpirun -np 1 --allow-run-as-root"`` options for all run commands**. For example, .. code:: bash