.. _wscan:

#####################################
Running ``wscan`` on the command line
#####################################

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

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

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

.. command-output:: wscan --help

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

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