Skip to main content

NMMA

NMMA

a pythonic library for probing nuclear physics and cosmology with multimessenger analysis



GitHub Repo stars GitHub forks Conda Downloads PyPI - Downloads Coverage Status CI PyPI version Python version

Citations to the NMMA code: Citation record

Read our official documentation: NMMA Documentation

Check out our contribution guide: For contributors

A tutorial on how to produce simulations of lightcurves is given here tutorial-lightcurve_simulation.ipynb

Citing NMMA

When using this code for a publication, kindly make a reference to the package by its name, NMMA, and a citation to the companion paper An updated nuclear-physics and multi-messenger astrophysics framework for binary neutron star mergers. The BibTeX entry for the paper is:

@article{Pang:2022rzc,
      title={An updated nuclear-physics and multi-messenger astrophysics framework for binary neutron star mergers},
      author={Peter T. H. Pang and Tim Dietrich and Michael W. Coughlin and Mattia Bulla and Ingo Tews and Mouza Almualla and Tyler Barna and Weizmann Kiendrebeogo and Nina Kunert and Gargi Mansingh and Brandon Reed and Niharika Sravan and Andrew Toivonen and Sarah Antier and Robert O. VandenBerg and Jack Heinzel and Vsevolod Nedora and Pouyan Salehi and Ritwik Sharma and Rahul Somasundaram and Chris Van Den Broeck},
      journal={Nature Communications},
      year={2023},
      month={Dec},
      day={20},
      volume={14},
      number={1},
      pages={8352},
      issn={2041-1723},
      doi={10.1038/s41467-023-43932-6},
      url={https://doi.org/10.1038/s41467-023-43932-6}
}

Since NMMA uses bilby as its backend, please also cite the bilby companion paper BILBY: A user-friendly Bayesian inference library for gravitational-wave astronomy. The BibTeX entry for the paper is:

@article{Ashton:2018jfp,
    author = "Ashton, Gregory and others",
    title = "{BILBY: A user-friendly Bayesian inference library for gravitational-wave astronomy}",
    eprint = "1811.02042",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    doi = "10.3847/1538-4365/ab06fc",
    journal = "Astrophys. J. Suppl.",
    volume = "241",
    number = "2",
    pages = "27",
    year = "2019"
}

If the gravitational-wave component of NMMA has been used, please see here for the exact citation guideline, depending on your use case.

If you are using the systematics error, please also cite the paper Data-driven approach for modeling the temporal and spectral evolution of kilonova systematic uncertainties. The BibTeX entry for the paper is:

@article{Jhawar:2024ezm,
    author = "Jhawar, Sahil and Wouters, Thibeau and Pang, Peter T. H. and Bulla, Mattia and Coughlin, Michael W. and Dietrich, Tim",
    title = "{Data-driven approach for modeling the temporal and spectral evolution of kilonova systematic uncertainties}",
    eprint = "2410.21978",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.HE",
    doi = "10.1103/PhysRevD.111.043046",
    journal = "Phys. Rev. D",
    volume = "111",
    number = "4",
    pages = "043046",
    year = "2025"
}

If you are using likelihood free inference, please also cite the paper Rapid parameter estimation for kilonovae using likelihood-free inference. The BibTeX entry for the paper is:

@article{Desai:2024hlp,
    author = "Desai, Malina and Chatterjee, Deep and Jhawar, Sahil and Harris, Philip and Katsavounidis, Erik and Coughlin, Michael",
    title = "{Kilonova Light Curve Parameter Estimation Using Likelihood-Free Inference}",
    eprint = "2408.06947",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    doi = "10.1093/mnras/staf1045",
    month = "8",
    year = "2024"
}

Based on the sampler used for the analysis, please also cite the associated papers:

dynesty: Zenodo entry 10.5281/zenodo.3348367 and the associated companion paper as follow:

@article{Speagle:2019ivv,
    author = "Speagle, Joshua S.",
    title = "{dynesty: a dynamic nested sampling package for estimating Bayesian posteriors and evidences}",
    eprint = "1904.02180",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.IM",
    doi = "10.1093/mnras/staa278",
    journal = "Mon. Not. Roy. Astron. Soc.",
    volume = "493",
    number = "3",
    pages = "3132--3158",
    year = "2020"
}

PyMultiNest:

@article{Buchner:2014nha,
    author = "Buchner, J. and Georgakakis, A. and Nandra, K. and Hsu, L. and Rangel, C. and Brightman, M. and Merloni, A. and Salvato, M. and Donley, J. and Kocevski, D.",
    title = "{X-ray spectral modelling of the AGN obscuring region in the CDFS: Bayesian model selection and catalogue}",
    eprint = "1402.0004",
    archivePrefix = "arXiv",
    primaryClass = "astro-ph.HE",
    doi = "10.1051/0004-6361/201322971",
    journal = "Astron. Astrophys.",
    volume = "564",
    pages = "A125",
    year = "2014"
}

UltraNest:

@article{Buchner:2021cql,
    author = "Buchner, Johannes",
    title = "{UltraNest -- a robust, general purpose Bayesian inference engine}",
    eprint = "2101.09604",
    archivePrefix = "arXiv",
    primaryClass = "stat.CO",
    reportNumber = "10.21105/joss.03001",
    month = "1",
    year = "2021"
}

Acknowledgments

If you benefited from participating in our community, we ask that you please acknowledge the Nuclear Multi-Messenger Astronomy collaboration, and particular individuals who helped you, in any publications. Please use the following text for this acknowledgment:

We acknowledge the Nuclear Multi-Messenger Astronomy collective as an open community of multi-domain experts and collaborators. This community and <names of individuals>, in particular, were important for the development of this project.

Funding

We gratefully acknowledge previous and current support from the U.S. National Science Foundation (NSF) Harnessing the Data Revolution (HDR) Institute for Accelerating AI Algorithms for Data Driven Discovery (A3D3) under Cooperative Agreement No. PHY-2117997 and the European Research Council (ERC) under the European Union's Starting Grant (Grant No. 101076369).

A3D3 NSF ERC

Metadata

Release files for nmma 1.0.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 nmma 1.0.1
File Size Uploaded
nmma-1.0.1.tar.gz 136.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for nmma 1.0.1
File Interpreter ABI Platform
nmma-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 204.2 MB

Release files / nmma-1.0.1.tar.gz

Download URL nmma-1.0.1.tar.gz
Size 136.6 MB
Tags Source
SHA-256 checksum
How to use checksums
4e0741cad9e4f3d6fe3f8d4c39a8db201a15832a4f0fb9cab6f0eb962cc4a2c2
BLAKE2b-256 checksum
How to use checksums
44cff4da830ce45d08f9676d97611eb3be9802d4a0b40f55caadebc43dee463b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / nmma-1.0.1-py3-none-any.whl

Download URL nmma-1.0.1-py3-none-any.whl
Size 67.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e5906d072c66e982b7b1439e0bd0e20ac3f8e9515878490c20a4c32b73647b0e
BLAKE2b-256 checksum
How to use checksums
27730f647b963f9cbd4b9894509db032e5b36650933870529a03e780891161f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

1 release file

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

0.0.19

1 release file

0.0.18

1 release file

0.0.17

1 release file

0.0.16

1 release file

0.0.15

1 release file

0.0.14

1 release file

0.0.13

1 release file

0.0.11

1 release file

0.0.10

1 release file

0.0.9

1 release file

0.0.8

1 release file

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

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