Skip to main content

A nuclear physics multi-messenger Bayesian inference library

Project description

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

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

nmma-1.0.0.tar.gz (136.6 MB view details)

Uploaded Source

Built Distribution

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

nmma-1.0.0-py3-none-any.whl (67.6 MB view details)

Uploaded Python 3

File details

Details for the file nmma-1.0.0.tar.gz.

File metadata

  • Download URL: nmma-1.0.0.tar.gz
  • Upload date:
  • Size: 136.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nmma-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a6dd84e2c74ae3a5efbf1fd89a1dbde0070040148fea7bf41ae8dda805af57d9
MD5 c0a88d528956c2ff1f8694176262d031
BLAKE2b-256 13ad883286d211c5f112cb520d9ced01876f4a792f9cc62fae6744ded4016a23

See more details on using hashes here.

File details

Details for the file nmma-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: nmma-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 67.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nmma-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b662206bf325e3a7c3463b4fc0e01abcaa9230ccfb5faa35471c2efa3022c179
MD5 68e938d3c3599558adf1f81294189a35
BLAKE2b-256 429005d50d38bd8c1653ed702feb7bf823e718c836c509606835f15bd3e45fdd

See more details on using hashes here.

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