emantis


Nameemantis JSON
Version 1.2.0 PyPI version JSON
download
home_pageNone
SummaryA cosmological emulator for non-linear large-scale structure formation studies in alternative dark energy and gravity theories.
upload_time2025-07-18 15:22:01
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.10
licenseGPL-3.0-or-later
keywords cosmology emulator large-scale structure dark energy modified gravity
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |DOI|_ |PyPI|_ |release|_ |pipeline|_

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7738362.svg
.. _DOI: https://doi.org/10.5281/zenodo.7738362

.. |PyPI| image:: https://img.shields.io/pypi/v/emantis
.. _PyPI: https://pypi.org/project/emantis/

.. |release| image:: https://gitlab.obspm.fr/e-mantis/e-mantis/-/badges/release.svg
.. _release: https://gitlab.obspm.fr/e-mantis/e-mantis/-/releases

.. |pipeline| image:: https://gitlab.obspm.fr/e-mantis/e-mantis/badges/main/pipeline.svg
.. _pipeline: https://gitlab.obspm.fr/e-mantis/e-mantis/-/commits/main

e-MANTIS: Emulator for Multiple observable ANalysis in extended cosmological TheorIeS
=====================================================================================

.. contents:: Table of Contents
   :local:

Description
-----------

e-MANTIS is a python package containing emulators providing theoretical predictions for the non-linear large-scale structure formation in the context of alternative dark energy and gravity theories.
It uses Gaussian processes to perform a fast and accurate interpolation between the outputs of high resolution cosmological :math:`N`-body simulations.
The emulator supports multiple cosmological models and observables.
It is divided in multiple modules, each one focusing on a particular type of observable.
Currently, e-MANTIS provides emulators for the following quantities:

* Matter power spectrum boost in f(R) gravity, described in: `The e-MANTIS emulator: fast predictions of the non-linear matter power spectrum in f(R)CDM cosmology <https://arxiv.org/abs/2303.08899>`_.

* Halo mass function in f(R)CDM and wCDM cosmologies, described in: `The e-MANTIS emulator: fast and accurate predictions of the halo mass function in f(R)CDM and wCDM cosmologies <https://arxiv.org/pdf/2410.05226>`_.

Please cite the corresponding papers if you use e-MANTIS in your work.

This project is under constant development.
More observables and cosmological models will be added in the future. Stay tuned!

Installation
------------

You can install the python package from `PyPI <https://pypi.org/project/emantis/>`_ via pip::

  pip install emantis

Or you can directly clone our public `repository <https://gitlab.obspm.fr/e-mantis/e-mantis>`_ and install it from source::

  git clone https://gitlab.obspm.fr/e-mantis/e-mantis.git
  cd e-mantis
  pip install [-e] .

It requires a python version >= 3.10.

Post-installation
-----------------

The emulators shipped with e-MANTIS need to be trained before they can provide predictions.
This will be done automatically and on-the-fly the first time you use each emulator.

Alternatively, we provide a CLI utility to train all emulators at once::

  emantis-train

This should not take more than a couple of minutes.

The trained emulators are saved to disk, using the pickle protocol, ready for future usage.
Major changes in the versions of python, e-MANTIS, or some of its main dependencies, such as numpy, scipy, or scikit-learn, might break the compatibility with previously trained emulators.
In such case, the emulators will be retrained automatically on-the-fly.
You can also retrain them manually using the CLI utility.

Documentation and usage
-----------------------

The up-to-date documentation for this project (with code examples and a detailed API) is available `here <https://e-mantis.pages.obspm.fr/e-mantis/index.html>`_.

Licence
-------

Copyright (C) 2023 Iñigo Sáez-Casares

inigo.saez-casares@obspm.fr

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see https://www.gnu.org/licenses/.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "emantis",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "cosmology, emulator, large-scale structure, dark energy, modified gravity",
    "author": null,
    "author_email": "I\u00f1igo S\u00e1ez Casares <inigo.saez-casares@obspm.fr>",
    "download_url": "https://files.pythonhosted.org/packages/8d/a1/8f3ee0f0fba1ee96b623a03c62d9a8940361006c3d71039f066d19ad346e/emantis-1.2.0.tar.gz",
    "platform": null,
    "description": "|DOI|_ |PyPI|_ |release|_ |pipeline|_\n\n.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7738362.svg\n.. _DOI: https://doi.org/10.5281/zenodo.7738362\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/emantis\n.. _PyPI: https://pypi.org/project/emantis/\n\n.. |release| image:: https://gitlab.obspm.fr/e-mantis/e-mantis/-/badges/release.svg\n.. _release: https://gitlab.obspm.fr/e-mantis/e-mantis/-/releases\n\n.. |pipeline| image:: https://gitlab.obspm.fr/e-mantis/e-mantis/badges/main/pipeline.svg\n.. _pipeline: https://gitlab.obspm.fr/e-mantis/e-mantis/-/commits/main\n\ne-MANTIS: Emulator for Multiple observable ANalysis in extended cosmological TheorIeS\n=====================================================================================\n\n.. contents:: Table of Contents\n   :local:\n\nDescription\n-----------\n\ne-MANTIS is a python package containing emulators providing theoretical predictions for the non-linear large-scale structure formation in the context of alternative dark energy and gravity theories.\nIt uses Gaussian processes to perform a fast and accurate interpolation between the outputs of high resolution cosmological :math:`N`-body simulations.\nThe emulator supports multiple cosmological models and observables.\nIt is divided in multiple modules, each one focusing on a particular type of observable.\nCurrently, e-MANTIS provides emulators for the following quantities:\n\n* Matter power spectrum boost in f(R) gravity, described in: `The e-MANTIS emulator: fast predictions of the non-linear matter power spectrum in f(R)CDM cosmology <https://arxiv.org/abs/2303.08899>`_.\n\n* Halo mass function in f(R)CDM and wCDM cosmologies, described in: `The e-MANTIS emulator: fast and accurate predictions of the halo mass function in f(R)CDM and wCDM cosmologies <https://arxiv.org/pdf/2410.05226>`_.\n\nPlease cite the corresponding papers if you use e-MANTIS in your work.\n\nThis project is under constant development.\nMore observables and cosmological models will be added in the future. Stay tuned!\n\nInstallation\n------------\n\nYou can install the python package from `PyPI <https://pypi.org/project/emantis/>`_ via pip::\n\n  pip install emantis\n\nOr you can directly clone our public `repository <https://gitlab.obspm.fr/e-mantis/e-mantis>`_ and install it from source::\n\n  git clone https://gitlab.obspm.fr/e-mantis/e-mantis.git\n  cd e-mantis\n  pip install [-e] .\n\nIt requires a python version >= 3.10.\n\nPost-installation\n-----------------\n\nThe emulators shipped with e-MANTIS need to be trained before they can provide predictions.\nThis will be done automatically and on-the-fly the first time you use each emulator.\n\nAlternatively, we provide a CLI utility to train all emulators at once::\n\n  emantis-train\n\nThis should not take more than a couple of minutes.\n\nThe trained emulators are saved to disk, using the pickle protocol, ready for future usage.\nMajor changes in the versions of python, e-MANTIS, or some of its main dependencies, such as numpy, scipy, or scikit-learn, might break the compatibility with previously trained emulators.\nIn such case, the emulators will be retrained automatically on-the-fly.\nYou can also retrain them manually using the CLI utility.\n\nDocumentation and usage\n-----------------------\n\nThe up-to-date documentation for this project (with code examples and a detailed API) is available `here <https://e-mantis.pages.obspm.fr/e-mantis/index.html>`_.\n\nLicence\n-------\n\nCopyright (C) 2023 I\u00f1igo S\u00e1ez-Casares\n\ninigo.saez-casares@obspm.fr\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see https://www.gnu.org/licenses/.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A cosmological emulator for non-linear large-scale structure formation studies in alternative dark energy and gravity theories.",
    "version": "1.2.0",
    "project_urls": {
        "documentation": "https://e-mantis.pages.obspm.fr/e-mantis/index.html",
        "repository": "https://gitlab.obspm.fr/e-mantis/e-mantis.git"
    },
    "split_keywords": [
        "cosmology",
        " emulator",
        " large-scale structure",
        " dark energy",
        " modified gravity"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e372dd3d824774e5057f92717f259156c92fa3c83714818686579caac5c5a9d4",
                "md5": "4d6f5ed34bcdca6afd245e2dd7ea4c92",
                "sha256": "e54dd4840eb38a6d11a546e6db4f940a41a13fceccdd94c3a8a7cc9de3f40cb7"
            },
            "downloads": -1,
            "filename": "emantis-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4d6f5ed34bcdca6afd245e2dd7ea4c92",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 20972595,
            "upload_time": "2025-07-18T15:21:55",
            "upload_time_iso_8601": "2025-07-18T15:21:55.616177Z",
            "url": "https://files.pythonhosted.org/packages/e3/72/dd3d824774e5057f92717f259156c92fa3c83714818686579caac5c5a9d4/emantis-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8da18f3ee0f0fba1ee96b623a03c62d9a8940361006c3d71039f066d19ad346e",
                "md5": "a6682d730958144dfe5525cca0355dc7",
                "sha256": "902ae057229593fc844b8263759335455127d1ba4c8b1e2681fbdb0b4409e9be"
            },
            "downloads": -1,
            "filename": "emantis-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a6682d730958144dfe5525cca0355dc7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 21022057,
            "upload_time": "2025-07-18T15:22:01",
            "upload_time_iso_8601": "2025-07-18T15:22:01.955119Z",
            "url": "https://files.pythonhosted.org/packages/8d/a1/8f3ee0f0fba1ee96b623a03c62d9a8940361006c3d71039f066d19ad346e/emantis-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-18 15:22:01",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "emantis"
}
        
Elapsed time: 0.38823s