Skip to content

Commit 369afb6

Browse files
authored
change reference style + add some new references to codes (#1713)
1 parent d226e05 commit 369afb6

File tree

4 files changed

+59
-5
lines changed

4 files changed

+59
-5
lines changed

Docs/source/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ def get_version():
6868

6969
# bibtex
7070
bibtex_bibfiles = ["refs.bib"]
71+
bibtex_default_style = "unsrt"
7172

7273
# Add any paths that contain templates here, relative to this directory.
7374
templates_path = ['_templates']

Docs/source/getting_started.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ to set the ``AMREX_HOME`` environment variable to point to the
2727

2828
.. index:: burn_cell
2929

30-
A good unit test to start with is ``burn_cell`` -- this is simply a
30+
A good unit test to start with is ``burn_cell`` --- this is simply a
3131
one-zone burn. In ``Microphysics/`` do:
3232

3333
.. prompt:: bash

Docs/source/index.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ AMReX-Astro Microphysics is a collection of microphysics routines (equations of
1010
reaction networks, ...) and utilities (ODE integrators, NSE solvers)
1111
for astrophysical simulation codes.
1212

13-
The original design was to support the `AMReX
14-
<https://github.com/amrex-codes/amrex>`_ codes `CASTRO
15-
<https://github.com/amrex-astro/Castro>`_ and MAESTRO (now `MAESTROeX
16-
<https://github.com/amrex-astro/MAESTROeX>`_). These all have a
13+
The original design was to support codes based on the `AMReX
14+
<https://github.com/amrex-codes/amrex>`_ adaptive mesh refinement library :cite:`amrex_joss`,
15+
including `CASTRO
16+
<https://github.com/amrex-astro/Castro>`_ :cite:`castro_I`, `MAESTROeX
17+
<https://github.com/amrex-astro/MAESTROeX>`_ :cite:`maestroex`, and Quokka :cite:`quokka`. These all have a
1718
consistent interface and the separate Microphysics repository allows
1819
them to share the same equation of state, reaction networks, and more.
1920
Later, Microphysics was adopted by the `Quokka <https://github.com/quokka-astro/quokka>`_

Docs/source/refs.bib

+52
Original file line numberDiff line numberDiff line change
@@ -701,3 +701,55 @@ @ARTICLE{itoh:1996
701701
adsurl = {https://ui.adsabs.harvard.edu/abs/1996ApJS..102..411I},
702702
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
703703
}
704+
705+
706+
@article{amrex_joss,
707+
doi = {10.21105/joss.01370},
708+
url = {https://doi.org/10.21105/joss.01370},
709+
year = {2019},
710+
publisher = {The Open Journal},
711+
volume = {4},
712+
number = {37},
713+
pages = {1370},
714+
author = {Weiqun Zhang and Ann Almgren and Vince Beckner and John Bell and Johannes Blaschke and Cy Chan and Marcus Day and Brian Friesen and Kevin Gott and Daniel Graves and Max P. Katz and Andrew Myers and Tan Nguyen and Andrew Nonaka and Michele Rosso and Samuel Williams and Michael Zingale},
715+
title = {AMReX: a framework for block-structured adaptive mesh refinement},
716+
journal = {Journal of Open Source Software} }
717+
718+
719+
@ARTICLE{maestroex,
720+
author = {{Fan}, Duoming and {Nonaka}, Andrew and {Almgren}, Ann S. and {Harpole}, Alice and {Zingale}, Michael},
721+
title = "{MAESTROeX: A Massively Parallel Low Mach Number Astrophysical Solver}",
722+
journal = {\apj},
723+
keywords = {Stellar convective zones, Hydrodynamics, Computational methods, Nuclear astrophysics, Nucleosynthesis, Nuclear abundances, 301, 1963, 1965, 1129, 1131, 1128, Physics - Computational Physics, Astrophysics - Solar and Stellar Astrophysics},
724+
year = 2019,
725+
month = dec,
726+
volume = {887},
727+
number = {2},
728+
eid = {212},
729+
pages = {212},
730+
doi = {10.3847/1538-4357/ab4f75},
731+
archivePrefix = {arXiv},
732+
eprint = {1908.03634},
733+
primaryClass = {physics.comp-ph},
734+
adsurl = {https://ui.adsabs.harvard.edu/abs/2019ApJ...887..212F},
735+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
736+
}
737+
738+
739+
@ARTICLE{quokka,
740+
author = {{Wibking}, Benjamin D. and {Krumholz}, Mark R.},
741+
title = "{QUOKKA: a code for two-moment AMR radiation hydrodynamics on GPUs}",
742+
journal = {\mnras},
743+
keywords = {hydrodynamics, methods: numerical, Astrophysics - Instrumentation and Methods for Astrophysics},
744+
year = 2022,
745+
month = may,
746+
volume = {512},
747+
number = {1},
748+
pages = {1430-1449},
749+
archivePrefix = {arXiv},
750+
eprint = {2110.01792},
751+
primaryClass = {astro-ph.IM},
752+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022MNRAS.512.1430W},
753+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
754+
}
755+

0 commit comments

Comments
 (0)