###########################
General options
###########################

.. role:: bash(code)
   :language: bash

Displaying options
=====================

pyCIF package is run as an executable through the `__main.py__` script.

To display available running options, use the following command:


.. code-block:: bash

    python -m pycif -h


Available options
===================

The available options are :

    - `def_file` (mandatory): defines the path to the configuration Yaml file
    - `-h` or `--help` (stand-alone): this displays the available options
    - `--debug` (optional): activate debugging verbose mode; this is equivalent to setting the `verbose` parameter to `0` in the configuration Yaml file (see :doc:`here <yaml/yaml>`).
    - `--faulhandler` (optional): activate the `faulthandler` python package to track external errors (e.g., in C sub-routines); **WARNING**, this option slows the computation.