Skip to content

Commit

Permalink
Adding documentation on run_scm.py --mpi_command argument
Browse files Browse the repository at this point in the history
  • Loading branch information
scrasmussen committed Sep 6, 2024
1 parent c85a9af commit 5f747c9
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion scm/doc/TechGuide/chap_quick.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <singlerunscript>`
**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
Expand Down

0 comments on commit 5f747c9

Please sign in to comment.