flint.predict.addmodel
======================

.. py:module:: flint.predict.addmodel

.. autoapi-nested-parse::

   Tooling around the use of the `addmodel` program packaged with `calibrate`.

   This tooling requires the `calibrate` container.



Classes
-------

.. autoapisummary::

   flint.predict.addmodel.AddModelOptions


Functions
---------

.. autoapisummary::

   flint.predict.addmodel.add_model
   flint.predict.addmodel.add_model_options_to_command
   flint.predict.addmodel.cli
   flint.predict.addmodel.get_parser


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

.. py:class:: AddModelOptions(/, **data: Any)

   Bases: :py:obj:`flint.options.BaseOptions`


   Container for options into the ``addmodel`` program packaged
   with ``aocalibrate``


   .. py:attribute:: datacolumn
      :type:  str

      The column that will be operated against


   .. py:attribute:: mode
      :type:  Literal['a', 's', 'c', 'v']

      The mode ``addmodel`` will be operating under, where where a=add model to visibilities (default), s=subtract model from visibilities, c=copy model to visibilities, z=zero visibilities


   .. py:attribute:: model_path
      :type:  pathlib.Path

      Path to the sky-model that will be inserted


   .. py:attribute:: ms_path
      :type:  pathlib.Path

      Path to the measurement set that will be interacted with


.. py:function:: add_model(add_model_options: AddModelOptions, container: pathlib.Path, remove_datacolumn: bool = False) -> AddModelOptions

   Use the ``addmodel`` program to predict the sky-model visibilities
   from a compatible source list (e.g. ``wsclean -save-source-list``)

   :param add_model_options: The set of supported options to be supplied to ``addmodel``
   :type add_model_options: AddModelOptions
   :param container: The calibrate container that contains the ``addmodel`` program
   :type container: Path
   :param remove_datacolumn: Whether to first remove the ``datacolumn`` specified in ``add_model_options`` before predicting. If False it should be overwritten. Defaults to False.
   :type remove_datacolumn: bool, optional

   :returns: The options used to run ``addmodel`` (same as input)
   :rtype: AddModelOptions


.. py:function:: add_model_options_to_command(add_model_options: AddModelOptions) -> str

   Generate the command to execute ``addmodel``

   :param add_model_options: The collection of supported options used to generate the command
   :type add_model_options: AddModelOptions

   :returns: The generated addmodel command
   :rtype: str


.. py:function:: cli() -> None

.. py:function:: get_parser() -> argparse.ArgumentParser