From c0abb749251207d51e410d8bd25b4ae10d1ecd42 Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Sat, 15 Feb 2025 15:59:03 -0500 Subject: [PATCH] add refs to pynucastro --- Docs/source/networks.rst | 2 +- Docs/source/nse_tabular.rst | 21 +++++++++++++-------- Docs/source/refs.bib | 31 ++++++++++++++++++++++++++++++- 3 files changed, 44 insertions(+), 10 deletions(-) diff --git a/Docs/source/networks.rst b/Docs/source/networks.rst index 4411495b7..d2c6d67b7 100644 --- a/Docs/source/networks.rst +++ b/Docs/source/networks.rst @@ -22,7 +22,7 @@ Microphysics knows the properties of the fluid. .. note:: Many of the networks here are generated using `pynucastro - `_ using the ``AmrexAstroCxxNetwork`` + `_ :cite:`pynucastro, pynucastro2` using the ``AmrexAstroCxxNetwork`` class. ``general_null`` diff --git a/Docs/source/nse_tabular.rst b/Docs/source/nse_tabular.rst index 963993bb9..b6cf979ae 100644 --- a/Docs/source/nse_tabular.rst +++ b/Docs/source/nse_tabular.rst @@ -34,14 +34,19 @@ Composition and EOS =================== The NSE table was generated using `pynucastro -` using 96 nuclei and -electron/positron capture/decay rates from :cite:`langanke:2001`. The -table takes $Y_e$ as the primary composition variable and provides a -set of mass fractions that is mapped into those used by ``aprox19``. -Using the value allows us to attain a lower :math:`Y_e` than -``aprox19`` can represent. - -For this reason, when we are using the NSE network, we always take the +`_ :cite:`pynucastro, +pynucastro2`, using 96 nuclei and electron/positron capture/decay +rates from :cite:`langanke:2001`. The table takes $Y_e$ as the +primary composition variable and provides a set of mass fractions that +is mapped into those used by ``aprox19``. Using the value allows us +to attain a lower :math:`Y_e` than ``aprox19`` can represent. + +.. note:: + + The full details of the NSE table are provided in :cite:`sdc-nse`. + The table can be regenerated using the script ``nse_tabular/make_nse_table.py``. + +When we are using the NSE network, we always take the composition quantities in the EOS directly from ``eos_state.aux[]`` instead of from ``eos_state.xn[]``. The ``AUX_THERMO`` preprocessor variable is enabled in this case, and the equations of state interpret diff --git a/Docs/source/refs.bib b/Docs/source/refs.bib index 7c44a3c95..952f15365 100644 --- a/Docs/source/refs.bib +++ b/Docs/source/refs.bib @@ -782,4 +782,33 @@ @article{lsode author = {{Radhakrishnan}, Krishnan and {Hindmarsh}, Alan C.}, journal = {Lawrence Livermore National Laboratory Report UCRL-ID-113855}, pages = {124} -} \ No newline at end of file +} + +@article{pynucastro, +author = {{Willcox}, D.~E. and {Zingale}, M.}, + title = "{pynucastro: an interface to nuclear reaction rates and code generator for reaction network equations}", + journal = {Journal of Open Source Software}, + year = 2018, + volume = 3, + number = 23, + pages = 588, + url = {https://doi.org/10.21105/joss.00588}, + doi = {10.21105/joss.00588}, + subject = {nuclear astrophysics} +} + +@article{pynucastro2, +doi = {10.3847/1538-4357/acbaff}, +url = {https://dx.doi.org/10.3847/1538-4357/acbaff}, +year = {2023}, +month = {apr}, +publisher = {The American Astronomical Society}, +volume = {947}, +number = {2}, +pages = {65}, +author = {Alexander I. Smith and Eric T. Johnson and Zhi Chen and Kiran Eiden and Donald E. Willcox and Brendan Boyd and Lyra Cao and Christopher J. DeGrendele and Michael Zingale}, +title = {pynucastro: A Python Library for Nuclear Astrophysics}, +journal = {The Astrophysical Journal}, +abstract = {We describe pynucastro 2.0, an open-source library for interactively creating and exploring astrophysical nuclear reaction networks. We demonstrate new methods for approximating rates and use detailed balance to create reverse rates, show how to build networks and determine whether they are appropriate for a particular science application, and discuss the changes made to the library over the past few years. Finally, we demonstrate the validity of the networks produced and share how we use pynucastro networks in simulation codes.}, + subject = {nuclear astrophysics} +}