gravelamps.lensing.generic
==========================

.. py:module:: gravelamps.lensing.generic

.. autoapi-nested-parse::

   Generic Lensing Functions

   Following are functions that are model agnostic and used to interface the specific model forms with
   the rest of the architecture. Also included is a main running script which forms the minimal program
   `gravelamps_generate_interpolator_data` which is included for HTCondor scheduling of lens data
   generation. This is not generally intended to be run by the user.

   Written by Mick Wright 2022

   Routines
   --------
   checkpoint_signal_handler
       Exits with checkpointing exit code (85) when receiving checkpoint signal
   get_additional_arguments
       Retrieves required additional arguments for model specific lens generation
   get_condor_config
       Generates condor settings from the user INI
   generate_interpolator_condor
       Builds and, if specified, submits a lens generation run for the HTCondor scheduler
   generate_inerpolator_data
       Performs lens generation for the specified model in the format needed

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   gravelamps.lensing.generic.get_additional_arguments
   gravelamps.lensing.generic.get_condor_config
   gravelamps.lensing.generic.generate_interpolator_condor
   gravelamps.lensing.generic.generate_interpolator_data
   gravelamps.lensing.generic.main


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

.. py:function:: get_additional_arguments(config, args, argument_list, type_list)

   
   Retrieves required additional arguments for model specific lens generation


   :Parameters:

       **config** : configparser.ConfigParser
           Object containing settings for user INI file

       **args** : argparse.Namespace
           Object containing commmandline arguments to program

       **argument_list** : List of str
           Model specific arguments to retrieve from config file

       **type_list** : List of type funcs
           Types of the arguments given in `argument_list`

   :Returns:

       **value_list** : List of objects
           Values of the arguments specified in `argument_list`













   ..
       !! processed by numpydoc !!

.. py:function:: get_condor_config(config, args, output_directories, model, file_dict)

   
   Generates HTCondor configuration from user settings in INI


   :Parameters:

       **config** : configparser.ConfigParser
           Object containing settings from user INI file

       **args** : argparse.Namespace
           Object containing commandline arguments to program

       **output_directories** : dict
           Contains paths to the folders for output

       **model** : str
           Full python path to the lens model

       **file_dict** : dict
           Contains the paths for the interpolator grid and data files

   :Returns:

       **condor_settings** : dict
           Contains settings used by HTCondor













   ..
       !! processed by numpydoc !!

.. py:function:: generate_interpolator_condor(args, output_directories, condor_settings)

   
   Builds and, if specified, submits a lens generation run for the HTCondor Scheduler.


   :Parameters:

       **args** : argparse.Namespace
           Object containing commandline arguments to program

       **output_directories** : dict
           Contains paths to the folders for output

       **file_dict** : dict
           Contains paths for interpolator grid and data files

       **condor_settings** : dict
           Contains the settings for HTCondor to use














   ..
       !! processed by numpydoc !!

.. py:function:: generate_interpolator_data(config, args, model, file_dict)

   
   Performs lens generation for the specified model in the format needed.

   Lens generation can be done in one of three ways --- it can be done locally from the
   `generate_interpolator_data` function for the model if it has it, it can be done locally
   from the `amplification_factor` function directly if the model is sufficiently speedy to not
   need a specific interpolator generation function, or it can generate an HTCondor DAG file to
   run one of these should scheduling be required.

   :Parameters:

       **config** : configparser.ConfigParser
           Object containing settings from user INI file

       **args** : argparse.Namespace
           Object containing commandline arguments to program

       **model** : str
           Full python path to the lensing model

       **file_dict** : dict
           Contains paths for interpolator grid and data files





   :Raises:

       AttributeError
           Occurs when no data generation functions exist within model module









   ..
       !! processed by numpydoc !!

.. py:function:: main()

   
   Forms the program `gravelamps_generate_interpolator_data`.

   This program is not intended to be run directly by the user, instead it is a minimal function
   that will be called by the HTCondor scheduler when it is being used. Users should use the more
   full features `gravelamps_generate_lens` program. If run, however, it will use the specified
   file dictionary and output to generate lens data directly.















   ..
       !! processed by numpydoc !!