=============================
Inference of Single Waveforms
=============================

Gravelamps main function is performing Bayesian parameter estimation and model
selection for the variety of implemented gravitational wave lensing models. One
such configuration is that for individual gravitational wave events. This
regime covers the microlensing and millilensing regimes and benefits from both
the wave and geometric optics implementations. To perform the parameter
estimation, Gravelamps wraps around the ``bilby`` and ``bilby_pipe``
frameworks.

Performing inference is handled by the ``gravelamps_inference`` entrypoint.
This may typically be run as follows::

    $ gravelamps_inference -o --option /path/to/ini-file.ini

Commandline Options
===================

-h, --help      Shows the help message and exits.

-v, --verbose   Display the maximum level of information from the logger. Will
                override the INI setting.

-l, --local     If set, all jobs will be performed locally instead of being
                built for a scheduler. Will override the INI
                setting.

Example INI
===========

The following example INI will generate the HTCondor submit files for a job
using the isolated point mass model to analyse an unlensed injection.

.. literalinclude:: example-files/inference-example.ini
   :language: ini

For a more detailed look at the options available in the INI file, please see
the :doc:`ini` page.