Metadata-Version: 2.4
Name: emantis
Version: 1.3.0
Summary: A cosmological emulator for nonlinear large-scale structure formation studies in alternative dark energy and gravity theories.
Keywords: cosmology,emulator,large-scale structure,dark energy,modified gravity
Author-Email: Iñigo Sáez-Casares <inigo.saez-casares@obspm.fr>
License-Expression: GPL-3.0-or-later
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Project-URL: repository, https://gitlab.obspm.fr/e-mantis/e-mantis.git
Project-URL: documentation, https://e-mantis.pages.obspm.fr/e-mantis/index.html
Requires-Python: >=3.10
Requires-Dist: h5py<4.0,>=3.8
Requires-Dist: scikit-learn<2,>=1.5
Requires-Dist: numpy<3.0,>=1.24
Requires-Dist: pydantic<3.0,>=2.6
Requires-Dist: tomli<3,>=2; python_version < "3.11"
Requires-Dist: joblib<2.0.0,>=1.3.2
Requires-Dist: scipy<2,>=1.15
Requires-Dist: threadpoolctl<4,>=3
Description-Content-Type: text/x-rst

|DOI|_ |PyPI|_ |release|_ |pipeline|_ |coverage|_

.. |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

.. |coverage| image:: https://gitlab.obspm.fr/e-mantis/e-mantis/badges/main/coverage.svg
.. _coverage: 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 nonlinear 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 nonlinear 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.

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>`_.

License
-------

e-MANTIS is distributed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).
