diff --git a/docs/gw_eos.txt b/docs/gw_eos.txt new file mode 100644 index 0000000000000000000000000000000000000000..905c43669af6104bbf89d5fc357b92fe2926dd6f --- /dev/null +++ b/docs/gw_eos.txt @@ -0,0 +1,20 @@ +.. gw_eos: + +==================================================== +Neutron Star Equation of State Modeling and Sampling +==================================================== + +Base class for EOS objects. Initialized with energy-density pressure data from either an 2D array or file. Includes plotting routines for common representations of EOS: + +.. autoclass:: bilby.gw.eos.TabularEOS + :members: + +Spectral decomposition parameterized EOS from Lindblom, 2010 (ArXiv: 1009.0738): + +.. autoclass:: bilby.gw.eos.SpectralDecompositionEOS + :members: + +A Neutron star EOS 'Family'. Constructing this object maps the passed EOS object to its corresponding mass-radius relationship by solving the TOV equations. Also includes plotting routines for mass-radius and several equivalent representations of NS Family: + +.. autoclass:: bilby.gw.eos.EOSFamily + :members: