NEoST

NEoST: A Python package for nested sampling of the neutron star equation of state - Published in JOSS (2025)

https://github.com/xpsi-group/neost

Scientific Fields

Repository

README.rst

.. _readme:


NEoST
=====

**An open-source code for dense matter equation
of state inference via nested sampling.**


NEoST is designed to infer constraints on the dense matter equation of state, 
based on cEFT models for the behaviour of dense matter in the crust of a 
neutron star and core parametrisations for the behaviour of dense matter in 
the core of a neutron star. NEoST allows users to choose from four different 
cEFT models and two different core parametrisations to construct an equation
of state. Users can then use Bayesian analysis techniques to combine this 
equation of state with measurements of a neutron star's mass and radius, 
or measurements of chirp mass in a neutron star merger gravitational wave event,
as well as the tidal deformabilities of the merging stars to obtain constraints
on the parameters of the studied equation of state.

It provides the following functionality:

* Comparison of dense matter physics models to astrophysical measurements.
* Easy-to-use equation of state framework to parametrise equations of state.
* Post-processing functionality to visualise NEoST's results.



For more details on current and planned capabilities, check out the 
`NEoST documentation `_.

Installation and Testing
------------------------

NEoST is best installed from source. The documentation provides
`step-by-step installation instructions `_
for Linux and for limited MacOS systems. Note, NEoST offers two install options for the Tolman-Oppenheimer-Volkoff equation solvers: one using Cython and the other using Python. If one wishes to install using Python (e.g., due to incompatability with Cython and so the TOV solvers don't cythonize), we estimate the approximate speed-up of using Cython to Python to be at least 15x (if dark matter is turned on) and 20x (if dark matter is turned off).

Documentation
-------------

The documentation for NEoST, including a number of tutorials, can be found at `https://xpsi-group.github.io/neost/ `_.

How to get in touch or get involved
-----------------------------------

We always welcome contributions and feedback! We are especially interested in 
hearing from you if

* something breaks,
* you spot bugs, 
* there is missing functionality, or you have suggestions for future development.

To get in touch, please `open an issue `_.
Even better, if you have code you'd be interested in contributing, please send a 
`pull request `_ (or get in touch 
and we'll help guide you through the process!). 

For more information, you can take a look at the documentation's 
`Contributing page `_. 

Citing NEoST
-----------
If you find this package useful in your research, please provide the appropriate acknowledgment 
and citation. `Our documentation `_ provides 
more detail, including BibTeX entries and links to `appropriate papers `_.

Copyright and Licensing
-----------------------
All content © 2020-2025 the authors.
The code is distributed under the GNU General Public License v3.0; see `LICENSE `_ for details.

Owner

JOSS Publication

NEoST: A Python package for nested sampling of the neutron star equation of state

Published

January 07, 2025

DOI

10.21105/joss.06003

Volume 10, Issue 105, Page 6003

Authors

Geert Raaijmakers
GRAPPA, Anton Pannekoek Institute for Astronomy and Institute of High-Energy Physics, University of Amsterdam, Science Park 904, 1098 XH Amsterdam, Netherlands

Nathan Rutherford
Department of Physics and Astronomy, University of New Hampshire, Durham, New Hampshire 03824, USA

Patrick Timmerman
Anton Pannekoek Institute for Astronomy, University of Amsterdam, Science Park 904, 1098 XH Amsterdam, Netherlands

Tuomo Salmi
Anton Pannekoek Institute for Astronomy, University of Amsterdam, Science Park 904, 1098 XH Amsterdam, Netherlands

Anna L. Watts
Anton Pannekoek Institute for Astronomy, University of Amsterdam, Science Park 904, 1098 XH Amsterdam, Netherlands

Chanda Prescod-Weinstein
Department of Physics and Astronomy, University of New Hampshire, Durham, New Hampshire 03824, USA

Isak Svensson
Technische Universität Darmstadt, Department of Physics, 64289 Darmstadt, Germany, ExtreMe Matter Institute EMMI, GSI Helmholtzzentrum für Schwerionenforschung GmbH, 64291 Darmstadt, Germany, Max-Planck-Institut für Kernphysik, Saupfercheckweg 1, 69117 Heidelberg, Germany

Melissa Mendes
Technische Universität Darmstadt, Department of Physics, 64289 Darmstadt, Germany, ExtreMe Matter Institute EMMI, GSI Helmholtzzentrum für Schwerionenforschung GmbH, 64291 Darmstadt, Germany, Max-Planck-Institut für Kernphysik, Saupfercheckweg 1, 69117 Heidelberg, Germany

Editor

Axel Donath

Tags

astrostatistics neutron stars

View PDF Review Thread Software Archive

GitHub Events

Committers

Last synced: 11 months ago

Issues and Pull Requests

Last synced: 6 months ago