Skip to content

Commit 1ab2230

Browse files
committed
paper formatting
1 parent ed5e003 commit 1ab2230

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

paper/paper.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'pyro: a framework for hydrodynamics explorations and prototyping'
33

44
tags:
5-
- python
5+
- Python
66
- hydrodynamics
77
- astrophysics
88
- physics
@@ -36,41 +36,41 @@ bibliography: paper.bib
3636

3737
# Summary
3838

39-
pyro is a python-based simulation framework designed for ease of
39+
`pyro` is a Python-based simulation framework designed for ease of
4040
implementation and exploration of hydrodynamics methods. It is
4141
built in a object-oriented fashion, allowing for the reuse of
4242
the core components and fast prototyping of new methods.
4343

44-
The original goal of pyro was to learn hydrodynamics methods through
45-
example, and it still serves this goal. At Stony Brook, pyro is used
44+
The original goal of `pyro` was to learn hydrodynamics methods through
45+
example, and it still serves this goal. At Stony Brook, `pyro` is used
4646
with new undergraduate researchers in our group to introduce them to
4747
the ideas of computational hydrodynamics. But the current framework
48-
has evolved to the point where pyro is used for prototyping
48+
has evolved to the point where `pyro` is used for prototyping
4949
hydrodynamics solvers before implementing them into science codes. An
5050
example of this is the 4th-order compressible solver built on the
5151
ideas of spectral deferred corrections (the `compressible_sdc`
5252
solver). This implementation was used as the model for the
5353
development of higher-order schemes in the Castro hydrodynamics code
5454
[@castro]. The low Mach number atmospheric solver (`lm_atm`) is based
55-
on the Maestro code [@maestro] and the pyro implementation will be
55+
on the Maestro code [@maestro] and the `pyro` implementation will be
5656
used to prototype new low Mach number algorithms before porting them
5757
to science codes.
5858

59-
In the time since the first pyro paper [@pyroI], the code has
59+
In the time since the first `pyro` paper [@pyroI], the code has
6060
undergone considerable development, gained a large number of solvers,
6161
adopted unit testing through pytest and documentation through sphinx,
62-
and a number of new contributors. pyro's functionality can now
62+
and a number of new contributors. `pyro`'s functionality can now
6363
be accessed directly through a `Pyro()` class, in addition to the
6464
original commandline script interface. This new interface in particular
6565
allows for easy use within Jupyter notebooks. We also now use HDF5
66-
for output instead of python's `pickle()` function. Previously, we used Fortran
66+
for output instead of Python's `pickle()` function. Previously, we used Fortran
6767
to speed up some performance-critical portions of the code. These routines
68-
could be called by the main python code by first compiling them using `f2py`.
69-
In the new version, we have replaced these Fortran routines by python functions
70-
that are compiled at runtime by `numba`. Consequently, pyro is now written
71-
entirely in python.
68+
could be called by the main Python code by first compiling them using `f2py`.
69+
In the new version, we have replaced these Fortran routines by Python functions
70+
that are compiled at runtime by `numba`. Consequently, `pyro` is now written
71+
entirely in Python.
7272

73-
The current pyro solvers are:
73+
The current `pyro` solvers are:
7474

7575
- linear advection (including a second-order unsplit CTU scheme, a
7676
method-of-lines piecewise linear solver$^\star$, a 4th-order
@@ -93,7 +93,7 @@ The current pyro solvers are:
9393

9494
- shallow water equations solver$^\star$
9595

96-
(solvers since the first pyro paper are marked with a $^\star$). Also
96+
(solvers since the first `pyro` paper are marked with a $^\star$). Also,
9797
new is support for Lagrangian tracer particles, which can be added to
9898
any solver that has a velocity field.
9999

0 commit comments

Comments
 (0)