synthpop.synthpop_utils.synthpop_control
========================================

.. py:module:: synthpop.synthpop_utils.synthpop_control

.. autoapi-nested-parse::

   This file contains the Parameters Class.
   Its task is to handel the configuration of SynthPop from the config files a Keyword input .
   And provide the different task in a Namespace Object.



Classes
-------

.. autoapisummary::

   synthpop.synthpop_utils.synthpop_control.ModuleKwargs
   synthpop.synthpop_utils.synthpop_control.PopParams
   synthpop.synthpop_utils.synthpop_control.Parameters


Functions
---------

.. autoapisummary::

   synthpop.synthpop_utils.synthpop_control.parser


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

.. py:class:: ModuleKwargs

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: name
      :type:  Optional[str]
      :value: ''



   .. py:attribute:: filename
      :type:  Optional[str]
      :value: ''



   .. py:method:: validate_filename(values)
      :classmethod:



   .. py:property:: init_kwargs


.. py:class:: PopParams

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: imf_func_kwargs
      :type:  ModuleKwargs


   .. py:attribute:: age_func_kwargs
      :type:  ModuleKwargs


   .. py:attribute:: metallicity_func_kwargs
      :type:  ModuleKwargs


   .. py:attribute:: population_density_kwargs
      :type:  ModuleKwargs


   .. py:attribute:: kinematics_func_kwargs
      :type:  ModuleKwargs


   .. py:attribute:: evolution_kwargs
      :type:  Optional[Union[ModuleKwargs, List[ModuleKwargs]]]
      :value: None



   .. py:attribute:: av_mass_corr
      :type:  Optional[float]
      :value: None



   .. py:attribute:: n_star_corr
      :type:  Optional[float]
      :value: None



   .. py:method:: parse_jsonfile(filename)
      :classmethod:



.. py:class:: Parameters(specific_config: str or None = None, default_config: str = DEFAULT_CONFIG_FILE, model_dir: str = DEFAULT_MODEL_DIR, **kwargs)

   NameSpace object to store the configuration parameters
   defined by keyword arguments, and in the configuration files


   .. py:attribute:: l_set
      :value: None



   .. py:attribute:: l_set_type
      :value: None



   .. py:attribute:: b_set
      :value: None



   .. py:attribute:: b_set_type
      :value: None



   .. py:attribute:: _categories


   .. py:attribute:: loc


   .. py:attribute:: model_dir


   .. py:attribute:: sun


   .. py:attribute:: extinction_map_kwargs


   .. py:method:: validate_mandatory_input()

      checks if all Mandatory files are provided



   .. py:method:: location_generator() -> Iterator[Tuple[float, float]]

      converts l_set and b_set into a location generator object
      as defined by the l/b_set_type



   .. py:method:: rest_loc_iterator()


   .. py:method:: log_settings()

      log the settings as json formatted file



   .. py:method:: read_default_config(default_config_file: str)

      reads settings from keyword arguments

      Parameters
      ----------
      default_config_file: str
          file and path of the default configuration file

      Return
      ------
      config_dir: str
          directory of default_config_file.




   .. py:method:: read_specific_config(config_file: str or None, config_dir: str = '.')

      reads settings from keyword arguments
      Parameters
      ----------
      config_file: str
          file and path of the  configuration file
      config_dir: str
          directory where config files can be found



   .. py:method:: read_kwargs_config(kwargs: dict)

      reads settings from keyword arguments

      Parameters
      ----------
      kwargs: dict
          dictionary of specifications



.. py:function:: parser() -> argparse.Namespace

   synthpop control and help interface