Skip to main content

A Python package for cosmological mass function calculations

Project description

MassFunc

A Python package for cosmological mass function calculations, including Press-Schechter, Sheth-Tormen mass functions, star formation rate density calculations, and more.

Features

  • Cosmological calculations: Support for various cosmological parameters and models
  • Mass function calculations: Implements Press-Schechter and Sheth-Tormen mass functions
  • Star formation rate density: Calculate SFRD with customizable parameters
  • Collapse fraction: Tools for calculating collapse fractions
  • Efficient interpolation: Built-in interpolation for fast calculations

Installation

From PyPI (recommended)

pip install massfunc

From source

git clone https://github.com/SOYONAOC/MassFunction.git
cd massfunc
pip install -e .

Quick Start

import massfunc

# Create a mass function calculator with default cosmology
mf = massfunc.Mass_func(ns=0.965, sigma8=0.811, h=0.674, omegam=0.315)

# Setup interpolation for faster calculations
mf.sigma2_interpolation_set()
mf.dsig2dm_interpolation_set()

# Calculate mass function at z=0 for a range of masses
import numpy as np
masses = np.logspace(10, 15, 100)  # 10^10 to 10^15 solar masses
z = 0.0

# Press-Schechter mass function
dndm_ps = mf.dndmps(masses, z)

# Sheth-Tormen mass function
dndm_st = mf.dndmst(masses, z)

# Star formation rate density
sfrd = massfunc.SFRD(ns=0.965, sigma8=0.811)
rho_sfr = sfrd.rhosfr(1e4, 1e8, z)

Classes and Methods

CosmologySet

Base class for cosmological parameters:

  • h: Dimensionless Hubble parameter
  • omegam: Matter density parameter
  • omegab: Baryon density parameter
  • omegalam: Dark energy density parameter

Mass_func

Main class for mass function calculations:

  • sigma2(): Variance of density field
  • dndmps(): Press-Schechter mass function
  • dndmst(): Sheth-Tormen mass function
  • dndmeps(): Extended PS mass function

Collapse_fraction

Calculate collapse fractions:

  • fcoll(): Collapse fraction
  • dfcolldz(): Derivative of collapse fraction with redshift

SFRD

Star formation rate density calculations:

  • rhosfr(): Star formation rate density
  • fstar(): Star formation efficiency
  • fduty(): Duty cycle

Dependencies

  • numpy >= 1.18.0
  • scipy >= 1.5.0
  • astropy >= 4.0
  • matplotlib >= 3.0.0
  • sympy >= 1.6.0
  • joblib >= 1.0.0

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Citation

If you use this package in your research, please cite:

@software{massfunc,
  author = {Your Name},
  title = {MassFunc: A Python package for cosmological mass function calculations},
  url = {https://github.com/yourusername/massfunc},
  version = {0.1.0},
  year = {2025}
}

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

Update log

Version 0.1.1

  • Added EPS (Extended Press-Schechter) collapse fraction calculation
  • New method fcolleps() in Collapse_fraction class
  • Enhanced collapse fraction functionality

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

massfunc-0.2.2.tar.gz (145.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

massfunc-0.2.2-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file massfunc-0.2.2.tar.gz.

File metadata

  • Download URL: massfunc-0.2.2.tar.gz
  • Upload date:
  • Size: 145.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for massfunc-0.2.2.tar.gz
Algorithm Hash digest
SHA256 6e14feda28f0637fed59bfc048be78ffc23a039c7491e9c1b59533897f75a493
MD5 264d0d4b016b6bbb29df4bf112877e02
BLAKE2b-256 f307ccf7a34014c8e683457d2176c9ddd89ca444ab64df1d8b84fc0d2fecdbc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for massfunc-0.2.2.tar.gz:

Publisher: massfunc.yml on SOYONAOC/MassFunction

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file massfunc-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: massfunc-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for massfunc-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5398741d33c6cb6d4cc3c9a1a92ca8a2dfd5a5d850e5c747e25c0c7fce49f49
MD5 8fa84ba15a9dfdc4563f442cbec0f4c8
BLAKE2b-256 46d729cf7a3681ecf39b55c62269861d5e0c0e29d3b1f822d7b783de6eb13650

See more details on using hashes here.

Provenance

The following attestation bundles were made for massfunc-0.2.2-py3-none-any.whl:

Publisher: massfunc.yml on SOYONAOC/MassFunction

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page