Start here

All tutorials listed below may be found as Jupyter notebooks under docs/source/. We encourage running these yourself as you go through the tutorials as a means of practice. Note, these scripts can take a considerable amount of time to run on your personal computer. To shorten the time to run the scripts, we recommend changing n_live_points=5000 to n_live_points=500. Any external data files needed such as the AP4 tabulated equation of state data and mass-radius data are available on GitHub. These data files should be saved in neost/examples/.

Overview of the available tutorials:

  • Piecewise Polytropic Example a python script detailing how to perform a basic inference run using the piecewise polytropic equation of state parameterization.

  • Piecewise Polytropic Prior Example a python script detailing how to perform prior sampling using the piecewise polytropic equation of state parameterization.

  • Piecewise Polytropic with ADM Example a python script detailing how to perform a basic inference run using the piecewise polytropic equation of state parameterization and the Nelson et al. 2018 bosonic asymmetric dark matter core model.

  • Piecewise Polytropic with ADM Prior Example a python script detailing how to perform prior sampling using the piecewise polytropic equation of state parameterization and the Nelson et al. 2018 bosonic asymmetric dark matter core model.

  • ADM admixed M-R and M-Tidal Example a python script detailing how to compute the mass-radius and mass-tidal deformability curve when ADM is considered.

  • Speed of Sound Example a python script demonstrating how to perform a basic inference run using the speed of sound equation of state parameterization.

  • Speed of Sound Prior Example Example a python script detailing how to perform prior sampling using the speed of sound equation of state parameterization.

  • Tabulated Example a python script demonstrating how to perform an inference run using the AP4 tabulated equation of state.

  • Tabulated Prior Example an informative python script detailing how to perform a basic prior sampling run using the AP4 tabulated equation of state.