gravelamps.generate_lens
========================

.. py:module:: gravelamps.generate_lens

.. autoapi-nested-parse::

   Lens Data Generation

   The following are the function which control generation of lens data. The main function which is
   accessed via `gravelamps_generate_lens` generates a grid of lens amplification factor data for the
   specified model, allowing construction of interpolators for application within waveform generation.

   Written by Mick Wright 2022

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   gravelamps.generate_lens.main


Module Contents
---------------

.. py:function:: main(_config=None, _args=None, _injection=False)

   
   Generate lens data for specified configuration

   The configuration should be specified witin the provided INI file. The function will then
   proceed to generate the data required---both the grid of dimensionless frequency and source
   position as well as the amplification factor data itself. If user has specified that they wish
   to run on an HTCondor scheduler, the program will construct the DAG necessary for data
   generation to run within the scheduler.

   :Parameters:

       **_config** : configparser.ConfigParser, optional
           INI configuration parser to use for settings

       **_args** : argparse.Namespace, optional
           Commandline arguments passed to program calling main function

       **_injection** : bool, optional
           Flag to set to run as injection or analysis

   :Returns:

       **interpolator_files** : dict
           Contains the paths to the grid and data file outputs.








   .. rubric:: Notes

   User should interact on a commandline level, the arguments to the function are provided for
   internal use when running as part of the larger inference constructions.





   ..
       !! processed by numpydoc !!