.. _command-line:

#################################################################
Running ``run_parameterized_models_event.py`` on the command line
#################################################################

As described on the home page, the main interface to the wscan algorithm is the command-line executable ``run_parameterized_models_event.py``.

Basic instructions
==================

Basic instructions on running ``run_parameterized_models_event.py`` can be gained by looking at the ``--help`` menu:

.. command-output:: run_parameterized_models_event.py --help

Detailed instructions
=====================

A few of the command-line options require special formatting, use the reference below for more detailed info.