Metadata-Version: 2.2
Name: act_dr6_mflike
Version: 0.9.0
Summary: ACT DR6 multi-frequency likelihood for cobaya
License: 
        
        BSD License
        
        Copyright (c) 2025, ACT Collaboration
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice, this
          list of conditions and the following disclaimer in the documentation and/or
          other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from this
          software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
        IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
        INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
        OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
        OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
        OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/ACTCollaboration/act_dr6_mflike
Project-URL: Source, https://github.com/ACTCollaboration/act_dr6_mflike
Project-URL: Tracker, https://github.com/ACTCollaboration/act_dr6_mflike/issues
Project-URL: Licensing, https://github.com/ACTCollaboration/act_dr6_mflike/main/LICENCE
Keywords: likelihood,ACT,DR6,cosmology
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: mflike>=1.0.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: camb; extra == "test"

=================================
ACT DR6 Multifrequency Likelihood
=================================

An external likelihood using `cobaya <https://github.com/CobayaSampler/cobaya>`_.

.. image:: https://img.shields.io/pypi/v/act_dr6_mflike.svg?style=flat
   :target: https://pypi.python.org/pypi/act_dr6_mflike
.. image:: https://github.com/ACTCollaboration/act_dr6_mflike/actions/workflows/testing.yml/badge.svg
   :target: https://github.com/ACTCollaboration/act_dr6_mflike/actions
   :alt: GitHub Workflow Status

Installing the code
-------------------

If you do not plan to dig into the code, you can simply install the
code with the following command

.. code:: shell

    python -m pip install act_dr6_mflike [--user]

Otherwise, you first need to clone this repository to some location

.. code:: shell

    git clone https://github.com/ACTCollaboration/act_dr6_mflike.git /where/to/clone

Then you can install the ``act_dr6_mflike`` likelihood and its dependencies *via*

.. code:: shell

    python -m pip install -e /where/to/clone

Installing ACT DR6 data
-----------------------

To install ACT D6 data, the easiest way is to use the ``cobaya-install`` binary and 
let it do the installation job. For instance, if you do the next command

.. code:: shell

    cobaya-install /where/to/clone/examples/act_dr6_example.yaml -p /where/to/put/packages

data and code such as `CAMB <https://github.com/cmbant/CAMB>`_ will be downloaded and installed
within the ``/where/to/put/packages`` directory. For more details, you can have a look to ``cobaya``
`documentation <https://cobaya.readthedocs.io/en/latest/installation_cosmo.html>`_.

Running/testing the code
------------------------

You can test the ``act_dr6_mflike`` likelihood (you will need ``CosmoRec`` to be installed and
``camb`` aware of it, see `installation instructions
<https://www.jb.man.ac.uk/~jchluba/Science/CosmoRec/CosmoRec.html>`_) by doing

.. code:: shell

    cobaya-run /where/to/clone/examples/act_dr6_example.yaml -p /where/to/put/packages

which should run a MCMC sampler for ACT DR6 official data file (*i.e.* ``dr6_data.fits`` in the
``act_dr6_example.yaml`` file) using the combination of TT, TE and EE spectra (*i.e.*
``polarizations: ['TT', 'TE', 'ET', 'EE']``). The results will be stored in the ``chains/mcmc``
directory.
