Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions CITATION

This file was deleted.

46 changes: 46 additions & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
If you use pyro, please cite the pyro JOSS paper *and* the latest Zenodo DOI.

## JOSS

The pyro JOSS paper is at: https://joss.theoj.org/papers/10.21105/joss.01265

You can cite it as:

```bibtex
@article{pyro_joss,
doi = {10.21105/joss.01265},
url = {https://doi.org/10.21105/joss.01265},
year = {2019},
publisher = {The Open Journal},
volume = {4},
number = {34},
pages = {1265},
author = {Alice Harpole and Michael Zingale and Ian Hawke and Taher Chegini},
title = {pyro: a framework for hydrodynamics explorations and prototyping},
journal = {Journal of Open Source Software}
}
```

## Astronomy and Computing

You can also additionally cite the paper from *Astronomy and Computing*:

```bibtex
@article{pyro_ac,
author = {{Zingale}, M.},
title = "{pyro: A teaching code for computational astrophysical hydrodynamics}",
journal = {Astronomy and Computing},
year = 2014,
month = {oct},
volume = 6,
pages = {52-62},
doi = {10.1016/j.ascom.2014.07.003}
}
```

## Zenodo

The latest pyro Zenodo record is at https://doi.org/10.5281/zenodo.2575564



1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
./document_problems.py
curl -L -H 'Accept: application/x-bibtex' https://zenodo.org/api/records/2575564 > source/zenodo.bibtex.txt
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
39 changes: 0 additions & 39 deletions docs/source/ack.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,5 @@
Acknowledgments
===============

The current pyro developers are listed in the `.zenodo.json` file that
is used for releases.

You are free to use this code and the accompanying notes in your
classes. Please credit "pyro development team" for the code, and
*please send a note to the pyro-help e-mail list describing how you
use it, so we can keep track of it (and help justify the development
effort).*

If you use pyro in a publication, please cite it using this bibtex
citation::

@article{pyro,
doi = {10.21105/joss.01265},
url = {https://doi.org/10.21105/joss.01265},
year = {2019},
publisher = {The Open Journal},
volume = {4},
number = {34},
pages = {1265},
author = {Alice Harpole and Michael Zingale and Ian Hawke and Taher Chegini},
title = {pyro: a framework for hydrodynamics explorations and prototyping},
journal = {Journal of Open Source Software}
}

pyro benefited from numerous useful discussions with Ann Almgren, John
Bell, and Andy Nonaka.


History
=======

The original pyro code was written in 2003-4 to help developer
Zingale understand these methods for himself. It was originally written
using the Numeric array package and handwritten C extensions for the
compute-intensive kernels. It was ported to numarray when that
replaced Numeric, and continued to use C extensions. This version
"pyro2" was resurrected beginning in 2012 and rewritten for numpy
using f2py, and brought up to date. Most recently we've dropped
f2py and are using numba for the compute-intensive kernels.

17 changes: 17 additions & 0 deletions docs/source/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Citing pyro
===========

You are free to use this code and the accompanying notes in your
classes. Please credit "pyro development team" for the code, and
*please make a post to the pyro github discussions describing how you
use it, so we can keep track of it (and help justify the development
effort).*

.. mdinclude:: ../../CITATION.md

The bibtex for the latest version is included below (updated automatically):

.. literalinclude:: ./zenodo.bibtex.txt
:language: bibtex


1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
'sphinx_copybutton',
'sphinx_math_dollar',
'sphinx-prompt',
'sphinx_mdinclude',
'IPython.sphinxext.ipython_console_highlighting',
'sphinx.ext.githubpages']

Expand Down
12 changes: 12 additions & 0 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
History
=======

The original pyro code was written in 2003-4 to help developer
Zingale understand these methods for himself. It was originally written
using the Numeric array package and handwritten C extensions for the
compute-intensive kernels. It was ported to numarray when that
replaced Numeric, and continued to use C extensions. This version
"pyro2" was resurrected beginning in 2012 and rewritten for numpy
using f2py, and brought up to date. Most recently we've dropped
f2py and are using numba for the compute-intensive kernels.

2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ new ideas.
:hidden:

help
history
ack
citing

.. toctree::
:maxdepth: 1
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ sphinxcontrib-bibtex
sphinx-math-dollar
sphinx-copybutton
sphinx-prompt
sphinx-mdinclude
importlib-metadata
prettytable
codespell
Loading