Skip to main content

Static Badge

pytests codecov Read the Docs

MENTAT-LSS

Realistic rendition of mentat-lss (aka spherex_emu), showing an emu inside the SPHEREx satellite dish. Image credit: Grace Gibbins

The Multipole Emulator for Nonlinear Tracer Analysis of Two-point statistics and Large Scale Structure (also known as spherex_emu) is a package providing tools to create and use a neural network emulator that outputs redshift-space galaxy power spectrum multipoles given a set of input cosmology + galaxy bias parameters. Said emulator is able to generate multipoles for multiple tracer and redhshift bins simultaniously. While originally designed for use in SPHEREx likelihood inference studies, mentat-lss can be used for any galaxy clustering survey (BOSS, DESI, etc).

For more details on how to use this package, check out our documentation on ReadTheDocs!

Installing the code

This package works on both Linux and MacOS (intel and arm64) platforms, and has so-far been tested using Python 3.9 - 3.11. There are two main methods to install the code.

Preliminaries

  1. To enable GPU functionality for network training, make sure you have CUDA installed (or python 3.8+ if using apple silicon).
  2. You will need some way to generate galaxy power spectrum multipoles to generate training sets. One option is to download and install both ps_1loop and ps_theory_calculator. You might need to request access to those repositories, in which case you can contact Yosuke Kobayashi (yosukekobayashi@arizona.edu). We are also working on interfacing this library with cocoa, so stay tuned!

In a clean enviornment, simply run,

pip install mentat-lss

Alternatively, if you would like to install from source (for example, you want to add to the package, or would like easier access to the provided config files)), you can do so in two different ways.

From source (automatic)

  1. Download this repository to your location of choice.
  2. In the base directory, simply run install.sh in the terminal. This script will create a new anaconda enviornment, fetch the corresponding version of PyTorch, and install the code, all automatically.

From source (manual)

  1. Download this repository to your location of choice.
  2. install the corresponding PyTorch version. If your machine doesn't have a GPU, you can skip this step.
  3. In the base directory, run python -m pip install ., which should install this repository as a package and all required dependencies.

To run the provided unit-tests, you can run the following command in the base repo directory,

python -m pytest tests

Using MENTAT-LSS

Check out our ReadTheDocs Page on a typical workflow process.

If you use this package for your research, please cite the following papers:

Authors

Metadata

Release files for mentat-lss 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mentat-lss 1.1.1
File Size Uploaded
mentat_lss-1.1.1.tar.gz 86.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mentat-lss 1.1.1
File Interpreter ABI Platform
mentat_lss-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 157.1 kB

Release files / mentat_lss-1.1.1.tar.gz

Download URL mentat_lss-1.1.1.tar.gz
Size 86.1 kB
Tags Source
SHA-256 checksum
How to use checksums
78640ed31d6477d9097476d0b78ee3d9ad84912edc9bcfb43edc21ddf5518c3d
BLAKE2b-256 checksum
How to use checksums
c6914e98ac37cc73ab08758540bbf3452ddce317bf0d7864f06adf85e32bafcd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Release files / mentat_lss-1.1.1-py3-none-any.whl

Download URL mentat_lss-1.1.1-py3-none-any.whl
Size 71.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
591f2c40bb828ecd23fc2d39730141a4883decc4ae770bcc4eaa805797095db4
BLAKE2b-256 checksum
How to use checksums
bd8f4cfd0ba0c9ed9815307497388ba1a4c5e6b0e91b70ad4bae9721c2ef0049
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.9.6

2 release files

0.9.5

2 release files

0.9.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page