.. _mole-manual:

mole manual
-----------

.. program:: mole

::

	mole <subcommand> [options]

Subcommands:

.. describe:: init
	
	:ref:`Initialize the mole environment including example configuration files <mole-cmd-init>`

.. describe:: go

	:ref:`Run the optimization <mole-cmd-go>`

.. describe:: clean

	:ref:`Clear old processing and result data <mole-cmd-clean>`

To get further help and a list of available options for any subcommand run::

    mole <subcommand> --help


Subcommands and options
^^^^^^^^^^^^^^^^^^^^^^^

Each subcommand has its own set of options. Use ``mole <subcommand> --help`` to
see which of the following options apply to any of the subcommands listed
above.

.. _mole-cmd-init:

init
""""

.. option:: ENVIRONMENT

	Name of the mole environment. Must be given.

.. option::    --force

		If given, a previously existing mole environment with the same name will
		be overwritten (including data and configuration files).

.. option::    --modules=MODULE(S)

        Which modules of mole shall be invoced. Choose between source inversion
        (``si``), ground motion (``gm``) or landslide (``si``). Combinations as
        e.g. ``si,gm`` are also allowed.


.. _mole-cmd-go:

go
"""

.. option::    --force

		If given, a previously existing mole environment with the same name will
		be overwritten (including data and configuration files).

.. option::    --event=EVENT_ID

		If given, evaluate local data in ./data/<event_id>.

.. option::    --data=DATA_DIR

		If given, evaluate given local data.

.. option::    --run=RUN_DIR

		If given, store all results in given directory.

.. option::    --config=CONFIG

		Directory with all module configuration files stored.

.. option::    --si_conf=SI_CONF

		SourceInversion config file, if config/si.conf shall not be used.

.. option::    --gm_conf=GM_CONF

		GroundMotion config file, if config/gm.conf shall not be used.

.. option::    --ls_conf=LS_CONF

		LandSlide config file, if config/ls.conf shall not be used.

.. option::    --create-report

		If given, Grond and IDS reports are created in the processing directory.	

.. _mole-cmd-clean:

clean
"""""
.. option::    --keep=KEEP_PATHS

	Give comma separated run names are kept while cleaning. Wildcards are allowed. Give as string.

.. option::    --remove=RM_PATHS

	Give comma separated run names are removed solely. Wildcards are allowed. Give as string.


Command line examples
---------------------

Initialize a mole environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Initialize a new mole runing folder called ``mole_directory`` with configuration only for the source inversion module (``si``).

::

    mole init mole_directory --modules=si


The option ``--force`` will clear any previous mole environment and initialize a new
clear one.


Run a full estimate
^^^^^^^^^^^^^^^^^^^

Run the optimization for the given event and create reports for the results with Grond and IDS.

::

	mole go --event Samos_20201030_115127 --create-report