Command-Line Options
====================

This page is generated from ``XGC_core/cpp/main/command_line_inputs.hpp`` by ``utils/python/document_cli.py``.

XGC runtime options are passed to the executable. For example:

.. code-block:: bash

   srun ./xgc -max_walltime "$((SLURM_TIMELIMIT - 10))"

Options
-------

``-max_walltime``
   Specifies a maximum walltime in minutes after which XGC will write a checkpoint and end the simulation

``--info``
   Prints build and backend information, then exits

``--dryrun``
   Partially runs XGC setup to check for some common input errors

``-n_ranks``
   Optional input if using --dryrun: Specify the number of MPI ranks you plan to use

``--debug``
   Activates extra barriered checkpoints and validity checks (not intended for production)

``--perf-barriers``
   Adds MPI barriers to top-level timers to help identify load imbalance

``--test``
   Checks particles against reference data

``--update-test``
   Updates reference data used in particle test

``--moments-test``
   Checks moments against reference data

``--update-moments-test``
   Updates reference data used in moments test