mflike


Namemflike JSON
Version 0.9.6 PyPI version JSON
download
home_pageNone
SummarySO LAT multi-frequency likelihood for cobaya
upload_time2024-03-28 21:45:48
maintainerNone
docs_urlNone
authorSimons Observatory Collaboration Power Spectrum Group aka so_ps 1 & 2
requires_python>=3.9.0
license BSD License Copyright (c) 2023, Simons Observatory Collaboration Analysis Library Task Force 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.
keywords likelihood so lat cosmology
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =============================
LAT Multifrequency Likelihood
=============================

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

.. image:: https://img.shields.io/pypi/v/mflike.svg?style=flat
   :target: https://pypi.python.org/pypi/mflike

.. image:: https://img.shields.io/github/actions/workflow/status/simonsobs/LAT_MFLike/testing.yml?branch=master
   :target: https://github.com/simonsobs/LAT_MFLike/actions

.. image:: https://readthedocs.org/projects/lat-mflike/badge/?version=latest
   :target: https://lat-mflike.readthedocs.io/en/latest/?badge=latest

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/simonsobs/LAT_MFLike/master?filepath=notebooks%2Fmflike_tutorial.ipynb

.. image:: https://codecov.io/gh/simonsobs/LAT_MFLike/branch/master/graph/badge.svg?token=qrrVcbNCs5
   :target: https://codecov.io/gh/simonsobs/LAT_MFLike


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

The easiest way to install and to use ``mflike`` likelihood is *via* ``pip``

.. code:: shell

    pip install mflike

If you want to dig into the code, you'd better clone this repository to some location

.. code:: shell

    git clone https://github.com/simonsobs/LAT_MFLike.git /where/to/clone

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

.. code:: shell

    pip install -e /where/to/clone

The ``-e`` option allow the developer to make changes within the ``mflike`` directory without having
to reinstall at every changes. If you plan to just use the likelihood and do not develop it, you can
remove the ``-e`` option.

Installing LAT likelihood data
------------------------------

Preliminary simulated data can be found at `NERSC
<https://portal.nersc.gov/cfs/sobs/users/MFLike_data>`_. You can download them by yourself but you
can also 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/mflike_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 ``mflike`` likelihood by doing

.. code:: shell

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

which should run a MCMC sampler for the simulation n°44 (*i.e.* ``data_sacc_00044.fits`` in the
``mflike_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.

Simulation releases
-------------------

- ``v0.8`` release has spectra produced with high accuracy camb parameters up to ``ell = 9000``, the foreground components are integrated in frequency using top-hat bandpasses, stored in the ``sacc`` files

- ``v0.7.1`` is a bugfix release of ``v0.7`` release where the mono-frequency and dirac bandpasses
  have been correctly set with the ``sacc`` files

- ``v0.7`` release includes the ACT like foregrounds. Simulation parameters are also stored within ``sacc`` metadata and the associated ``dict`` file can be viewed `here <https://gist.github.com/xgarrido/5d2fdbe4232cfa9ad1156ee30baa7811>`_.

- ``v0.6`` release make use of CMB map based simulations (see https://github.com/simonsobs/map_based_simulations/blob/master/201911_lensed_cmb/README.md). Only temperature foregrounds were considered.

Releases prior to ``v0.6`` version were development simulations and should not be used for simulation analysis.

Contributors
------------

.. image:: https://contrib.rocks/image?repo=simonsobs/LAT_MFLike
   :target: https://github.com/simonsobs/LAT_MFLike/graphs/contributors

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mflike",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": null,
    "keywords": "likelihood, SO LAT, cosmology",
    "author": "Simons Observatory Collaboration Power Spectrum Group aka so_ps 1 & 2",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/de/23/dfa19b5c1f6d10c926ce2f50ac1b80a0bfc4cb89b6c63b3a01040c6f69cf/mflike-0.9.6.tar.gz",
    "platform": null,
    "description": "=============================\nLAT Multifrequency Likelihood\n=============================\n\nAn external likelihood using `cobaya <https://github.com/CobayaSampler/cobaya>`_.\n\n.. image:: https://img.shields.io/pypi/v/mflike.svg?style=flat\n   :target: https://pypi.python.org/pypi/mflike\n\n.. image:: https://img.shields.io/github/actions/workflow/status/simonsobs/LAT_MFLike/testing.yml?branch=master\n   :target: https://github.com/simonsobs/LAT_MFLike/actions\n\n.. image:: https://readthedocs.org/projects/lat-mflike/badge/?version=latest\n   :target: https://lat-mflike.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/simonsobs/LAT_MFLike/master?filepath=notebooks%2Fmflike_tutorial.ipynb\n\n.. image:: https://codecov.io/gh/simonsobs/LAT_MFLike/branch/master/graph/badge.svg?token=qrrVcbNCs5\n   :target: https://codecov.io/gh/simonsobs/LAT_MFLike\n\n\nInstalling the code\n-------------------\n\nThe easiest way to install and to use ``mflike`` likelihood is *via* ``pip``\n\n.. code:: shell\n\n    pip install mflike\n\nIf you want to dig into the code, you'd better clone this repository to some location\n\n.. code:: shell\n\n    git clone https://github.com/simonsobs/LAT_MFLike.git /where/to/clone\n\nThen you can install the ``mflike`` likelihood and its dependencies *via*\n\n.. code:: shell\n\n    pip install -e /where/to/clone\n\nThe ``-e`` option allow the developer to make changes within the ``mflike`` directory without having\nto reinstall at every changes. If you plan to just use the likelihood and do not develop it, you can\nremove the ``-e`` option.\n\nInstalling LAT likelihood data\n------------------------------\n\nPreliminary simulated data can be found at `NERSC\n<https://portal.nersc.gov/cfs/sobs/users/MFLike_data>`_. You can download them by yourself but you\ncan also use the ``cobaya-install`` binary and let it do the installation job. For instance, if you\ndo the next command\n\n.. code:: shell\n\n    cobaya-install /where/to/clone/examples/mflike_example.yaml -p /where/to/put/packages\n\ndata and code such as `CAMB <https://github.com/cmbant/CAMB>`_ will be downloaded and installed\nwithin the ``/where/to/put/packages`` directory. For more details, you can have a look to ``cobaya``\n`documentation <https://cobaya.readthedocs.io/en/latest/installation_cosmo.html>`_.\n\nRunning/testing the code\n------------------------\n\nYou can test the ``mflike`` likelihood by doing\n\n.. code:: shell\n\n    cobaya-run /where/to/clone/examples/mflike_example.yaml -p /where/to/put/packages\n\nwhich should run a MCMC sampler for the simulation n\u00b044 (*i.e.* ``data_sacc_00044.fits`` in the\n``mflike_example.yaml`` file) using the combination of TT, TE and EE spectra (*i.e.*\n``polarizations: ['TT', 'TE', 'ET', 'EE']``). The results will be stored in the ``chains/mcmc``\ndirectory.\n\nSimulation releases\n-------------------\n\n- ``v0.8`` release has spectra produced with high accuracy camb parameters up to ``ell = 9000``, the foreground components are integrated in frequency using top-hat bandpasses, stored in the ``sacc`` files\n\n- ``v0.7.1`` is a bugfix release of ``v0.7`` release where the mono-frequency and dirac bandpasses\n  have been correctly set with the ``sacc`` files\n\n- ``v0.7`` release includes the ACT like foregrounds. Simulation parameters are also stored within ``sacc`` metadata and the associated ``dict`` file can be viewed `here <https://gist.github.com/xgarrido/5d2fdbe4232cfa9ad1156ee30baa7811>`_.\n\n- ``v0.6`` release make use of CMB map based simulations (see https://github.com/simonsobs/map_based_simulations/blob/master/201911_lensed_cmb/README.md). Only temperature foregrounds were considered.\n\nReleases prior to ``v0.6`` version were development simulations and should not be used for simulation analysis.\n\nContributors\n------------\n\n.. image:: https://contrib.rocks/image?repo=simonsobs/LAT_MFLike\n   :target: https://github.com/simonsobs/LAT_MFLike/graphs/contributors\n",
    "bugtrack_url": null,
    "license": "  BSD License  Copyright (c) 2023, Simons Observatory Collaboration Analysis Library Task Force 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. ",
    "summary": "SO LAT multi-frequency likelihood for cobaya",
    "version": "0.9.6",
    "project_urls": {
        "Homepage": "https://github.com/simonsobs/LAT_MFLike",
        "Licensing": "https://github.com/simonsobs/LAT_MFLike/blob/master/LICENCE",
        "Source": "https://github.com/simonsobs/LAT_MFLike",
        "Tracker": "https://github.com/simonsobs/LAT_MFLike/issues"
    },
    "split_keywords": [
        "likelihood",
        " so lat",
        " cosmology"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e99f983c9a7a047235efe255a9497fc7493b6802591d71e0357e4aed2153cee",
                "md5": "e7bb1ffdb5f92f08c2316b36f0ac85e5",
                "sha256": "69c76c2267fd9c12ec16dc91ab09e5340bb2514e1c042551c9744abef0145703"
            },
            "downloads": -1,
            "filename": "mflike-0.9.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7bb1ffdb5f92f08c2316b36f0ac85e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.0",
            "size": 1117238,
            "upload_time": "2024-03-28T21:45:46",
            "upload_time_iso_8601": "2024-03-28T21:45:46.074005Z",
            "url": "https://files.pythonhosted.org/packages/2e/99/f983c9a7a047235efe255a9497fc7493b6802591d71e0357e4aed2153cee/mflike-0.9.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de23dfa19b5c1f6d10c926ce2f50ac1b80a0bfc4cb89b6c63b3a01040c6f69cf",
                "md5": "92fdca169f9ca906ef4562341db99200",
                "sha256": "aa8907b0ba26c20fe86838ca0a2f710f5019a9d3e13b6adba27cbfd3c8cff817"
            },
            "downloads": -1,
            "filename": "mflike-0.9.6.tar.gz",
            "has_sig": false,
            "md5_digest": "92fdca169f9ca906ef4562341db99200",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.0",
            "size": 1117870,
            "upload_time": "2024-03-28T21:45:48",
            "upload_time_iso_8601": "2024-03-28T21:45:48.398314Z",
            "url": "https://files.pythonhosted.org/packages/de/23/dfa19b5c1f6d10c926ce2f50ac1b80a0bfc4cb89b6c63b3a01040c6f69cf/mflike-0.9.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-28 21:45:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonsobs",
    "github_project": "LAT_MFLike",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mflike"
}
        
Elapsed time: 0.22442s