Skip to content

Commit b2e3a45

Browse files
authored
Merge pull request #138 from warrickball/joss-tweaks-1
Initial editorial tweaks for JOSS paper
2 parents 113493f + be69854 commit b2e3a45

2 files changed

Lines changed: 52 additions & 53 deletions

File tree

Paper/paper/paper.bib

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ @book{Binney:2008
1010
@ARTICLE{Gadget4,
1111
author = {{Springel}, Volker and {Pakmor}, R{\"u}diger and {Zier}, Oliver and {Reinecke}, Martin},
1212
title = "{Simulating cosmic structure formation with the GADGET-4 code}",
13-
journal = {Monthly Notices of the RAS},
13+
journal = {Monthly Notices of the Royal Astronomical Society},
1414
keywords = {methods: numerical, galaxies: interactions, dark matter, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics},
1515
year = 2021,
1616
month = sep,
@@ -30,7 +30,7 @@ @ARTICLE{Gadget4
3030
@ARTICLE{Wang:15,
3131
author = {{Wang}, Long and {Spurzem}, Rainer and {Aarseth}, Sverre and {Nitadori}, Keigo and {Berczik}, Peter and {Kouwenhoven}, M.~B.~N. and {Naab}, Thorsten},
3232
title = "{NBODY6++GPU: ready for the gravitational million-body problem}",
33-
journal = {Monthly Notices of the RAS},
33+
journal = {Monthly Notices of the Royal Astronomical Society},
3434
keywords = {methods: numerical, globular clusters: general, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
3535
year = 2015,
3636
month = jul,
@@ -50,14 +50,15 @@ @ARTICLE{Wang:15
5050
@article{gaia,
5151
author = {{Gaia Collaboration}},
5252
title = "{The Gaia mission}",
53-
journal = {Astronomy and Astrophysics},
53+
journal = {Astronomy \& Astrophysics},
5454
archivePrefix = "arXiv",
5555
eprint = {1609.04153},
5656
primaryClass = "astro-ph.IM",
5757
keywords = {space vehicles: instruments, Galaxy: structure, astrometry, parallaxes, proper motions, telescopes},
5858
year = 2016,
5959
month = nov,
6060
volume = 595,
61+
pages = "A1",
6162
doi = {10.1051/0004-6361/201629272},
6263
url = {http://adsabs.harvard.edu/abs/2016A%26A...595A...1G},
6364
}
@@ -68,7 +69,7 @@ @article{gaia_DR2_disk
6869
Doi = {10.1051/0004-6361/201832865},
6970
Eid = {A11},
7071
Eprint = {1804.09380},
71-
Journal = {Astronomy and Astrophysics},
72+
Journal = {Astronomy \& Astrophysics},
7273
Month = {Aug},
7374
Pages = {A11},
7475
Primaryclass = {astro-ph.GA},
@@ -80,7 +81,7 @@ @article{gaia_DR2_disk
8081
@article{astropy,
8182
author = {{Astropy Collaboration}},
8283
title = "{Astropy: A community Python package for astronomy}",
83-
journal = {Astronomy and Astrophysics},
84+
journal = {Astronomy \& Astrophysics},
8485
archivePrefix = "arXiv",
8586
eprint = {1307.6212},
8687
primaryClass = "astro-ph.IM",
@@ -101,13 +102,13 @@ @article{gala
101102
volume = {2},
102103
number = {18},
103104
author = {Adrian M. Price-Whelan},
104-
title = {Gala: A Python package for galactic dynamics},
105+
title = "{Gala: A Python package for galactic dynamics}",
105106
journal = {The Journal of Open Source Software}}
106107

107108

108109
@misc{hdf5,
109110
author = {{The HDF Group}},
110-
title = "{Hierarchical data format version 5}",
111+
title = "{Hierarchical Data Format, version 5}",
111112
year = {2000-2010},
112113
howpublished = {http://www.hdfgroup.org/HDF5}
113114
}
@@ -116,13 +117,13 @@ @misc{pybind11
116117
author = {Wenzel Jakob and Jason Rhinelander and Dean Moldovan},
117118
year = {2017},
118119
note = {https://github.com/pybind/pybind11},
119-
title = {pybind11 -- Seamless operability between C++11 and Python}
120+
title = "{pybind11 -- Seamless operability between C++11 and Python}"
120121
}
121122

122123
@ARTICLE{Weinberg:23,
123124
author = {{Weinberg}, Martin D.},
124125
title = "{New dipole instabilities in spherical stellar systems}",
125-
journal = {Monthly Notices of the RAS},
126+
journal = {Monthly Notices of the Royal Astronomical Society},
126127
year = 2023,
127128
month = nov,
128129
volume = {525},
@@ -137,7 +138,7 @@ @ARTICLE{Weinberg:23
137138
@ARTICLE{Weinberg:21,
138139
author = {{Weinberg}, Martin D. and {Petersen}, Michael S.},
139140
title = "{Using multichannel singular spectrum analysis to study galaxy dynamics}",
140-
journal = {Monthly Notices of the RAS},
141+
journal = {Monthly Notices of the Royal Astronomical Society},
141142
year = 2021,
142143
month = mar,
143144
volume = {501},
@@ -152,7 +153,7 @@ @ARTICLE{Weinberg:21
152153
@ARTICLE{Petersen:22,
153154
author = {{Petersen}, Michael S. and {Weinberg}, Martin D. and {Katz}, Neal},
154155
title = "{EXP: N-body integration using basis function expansions}",
155-
journal = {Monthly Notices of the RAS},
156+
journal = {Monthly Notices of the Royal Astronomical Society},
156157
keywords = {methods: numerical, Galaxy: halo, galaxies: haloes, galaxies: kinematics and dynamics, galaxies: structure, Astrophysics - Astrophysics of Galaxies, Astrophysics - Instrumentation and Methods for Astrophysics},
157158
year = 2022,
158159
month = mar,
@@ -168,7 +169,7 @@ @ARTICLE{Petersen:22
168169
@ARTICLE{Johnson:23,
169170
author = {{Johnson}, Alexander C. and {Petersen}, Michael S. and {Johnston}, Kathryn V. and {Weinberg}, Martin D.},
170171
title = "{Dynamical data mining captures disc-halo couplings that structure galaxies}",
171-
journal = {Monthly Notices of the RAS},
172+
journal = {Monthly Notices of the Royal Astronomical Society},
172173
keywords = {galaxies: disc, galaxies: haloes, galaxies: structure, Astrophysics - Astrophysics of Galaxies, Astrophysics - Instrumentation and Methods for Astrophysics},
173174
year = 2023,
174175
month = may,
@@ -187,7 +188,7 @@ @book{SSA
187188
year={2001},
188189
publisher={CRC press}
189190
}
190-
191+
191192
@Article{numpy,
192193
title = {Array programming with {NumPy}},
193194
author = {Charles R. Harris and K. Jarrod Millman and St{\'{e}}fan J.
@@ -227,8 +228,8 @@ @Article{matplotlib
227228

228229
@ARTICLE{Weinberg:99,
229230
author = {{Weinberg}, Martin D.},
230-
title = "{An Adaptive Algorithm for N-Body Field Expansions}",
231-
journal = {Astronomical Journal},
231+
title = {An Adaptive Algorithm for {N}-Body Field Expansions},
232+
journal = {The Astronomical Journal},
232233
keywords = {CELESTIAL MECHANICS, STELLAR DYNAMICS, GALAXIES: STRUCTURE, GALAXY: STRUCTURE, METHODS: NUMERICAL, Astrophysics},
233234
year = 1999,
234235
month = jan,
@@ -277,11 +278,11 @@ @INCOLLECTION{jupyter
277278
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
278279
}
279280

280-
@misc{cuda,
281-
author={NVIDIA and Vingelmann, Péter and Fitzek, Frank H.P.},
282-
title={CUDA, release: 10.2.89},
283-
year={2020},
284-
url={https://developer.nvidia.com/cuda-toolkit},
281+
@misc{cuda,
282+
author={NVIDIA and Vingelmann, Péter and Fitzek, Frank H.P.},
283+
title={CUDA, release: 10.2.89},
284+
year={2020},
285+
url={https://developer.nvidia.com/cuda-toolkit},
285286
}
286287

287288
@manual{mpi41,
@@ -296,7 +297,7 @@ @manual{mpi41
296297
@ARTICLE{GaravitoCamargo:21,
297298
author = {{Garavito-Camargo}, Nicol{\'a}s and {Besla}, Gurtina and {Laporte}, Chervin F.~P. and {Price-Whelan}, Adrian M. and {Cunningham}, Emily C. and {Johnston}, Kathryn V. and {Weinberg}, Martin and {G{\'o}mez}, Facundo A.},
298299
title = "{Quantifying the Impact of the Large Magellanic Cloud on the Structure of the Milky Way's Dark Matter Halo Using Basis Function Expansions}",
299-
journal = {Astrophysical Journal},
300+
journal = {The Astrophysical Journal},
300301
keywords = {Milky Way dynamics, Large Magellanic Cloud, Milky Way dark matter halo, 1051, 903, 1049, Astrophysics - Astrophysics of Galaxies},
301302
year = 2021,
302303
month = oct,
@@ -314,8 +315,8 @@ @ARTICLE{GaravitoCamargo:21
314315

315316
@ARTICLE{Hernquist:90,
316317
author = {{Hernquist}, Lars},
317-
title = "{An Analytical Model for Spherical Galaxies and Bulges}",
318-
journal = {Astrophysical Journal},
318+
title = {An Analytical Model for Spherical Galaxies and Bulges},
319+
journal = {The Astrophysical Journal},
319320
keywords = {Computational Astrophysics, Elliptical Galaxies, Galactic Bulge, Galactic Structure, Astronomical Models, Astronomical Photometry, Brightness Distribution, Distribution Functions, Astrophysics, GALAXIES: PHOTOMETRY, GALAXIES: STRUCTURE},
320321
year = 1990,
321322
month = jun,
@@ -330,8 +331,8 @@ @ARTICLE{Hernquist:90
330331

331332
@ARTICLE{Hernquist:92,
332333
author = {{Hernquist}, Lars and {Ostriker}, Jeremiah P.},
333-
title = "{A Self-consistent Field Method for Galactic Dynamics}",
334-
journal = {Astrophysical Journal},
334+
title = {A Self-consistent Field Method for Galactic Dynamics},
335+
journal = {The Astrophysical Journal},
335336
keywords = {Celestial Mechanics, Computational Astrophysics, Galaxies, Stellar Motions, Algorithms, Astronomical Models, Dynamical Systems, Numerical Analysis, Astrophysics, CELESTIAL MECHANICS, STELLAR DYNAMICS, METHODS: NUMERICAL},
336337
year = 1992,
337338
month = feb,
@@ -344,8 +345,8 @@ @ARTICLE{Hernquist:92
344345

345346
@ARTICLE{NFW,
346347
author = {{Navarro}, Julio F. and {Frenk}, Carlos S. and {White}, Simon D.~M.},
347-
title = "{A Universal Density Profile from Hierarchical Clustering}",
348-
journal = {Astrophysical Journal},
348+
title = {A Universal Density Profile from Hierarchical Clustering},
349+
journal = {The Astrophysical Journal},
349350
keywords = {Cosmology: Theory, Cosmology: Dark Matter, Galaxies: Halos, Methods: Numerical, Astrophysics},
350351
year = 1997,
351352
month = dec,
@@ -359,4 +360,3 @@ @ARTICLE{NFW
359360
adsurl = {https://ui.adsabs.harvard.edu/abs/1997ApJ...490..493N},
360361
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
361362
}
362-

Paper/paper/paper.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ authors:
1818
affiliations:
1919
- name: University of Edinburgh, UK
2020
index: 1
21-
- name: University of Massachusetts/Amherst, USA
21+
- name: University of Massachusetts Amherst, USA
2222
index: 2
2323
date: 01 June 2024
2424
bibliography: paper.bib
@@ -39,16 +39,16 @@ bodies to evolve under their mutual gravity are capable of reproducing
3939
such complexities but robust links to fundamental theoretical
4040
explanations are still missing.
4141

42-
Basis Function Expansions (BFE) represent fields as a linear
42+
Basis Function Expansions (BFEs) represent fields as a linear
4343
combination of orthogonal functions. BFEs are particularly well-suited
4444
for studies of perturbations from equilibrium, such as the evolution
4545
of a galaxy. For any galaxy simulation, a biorthogonal BFE can fully
4646
represent the density, potential and forces by time series of
4747
coefficients. The coefficients have physical meaning: they represent
48-
the gravitational potential energy in a given function. The variation
48+
the gravitational potential energy in a given function. The variation of
4949
the function coefficients in time encodes the dynamical evolution.
50-
The representation of simulation data by BFE results in huge
51-
compression of the information in the dynamical fields; for example,
50+
The representation of simulation data by BFEs results in huge
51+
compression of the information in the dynamical fields. For example,
5252
1.5 TB of phase space data enumerating the positions and velocities of
5353
millions of particles becomes 200 MB of coefficient data!
5454

@@ -73,7 +73,7 @@ The need for methodology that seamlessly connects theoretical
7373
descriptions of dynamics, N-body simulations, and compact descriptions
7474
of observed data gave rise to `EXP`. This package provides recent
7575
developments from applied mathematics and numerical computation to
76-
represent complete series of _Basis Function Expansions_ that describe
76+
represent complete series of BFEs that describe
7777
the variation of _any_ field in space. In the context of galactic
7878
dynamics, these fields may be density, potential, force, velocity
7979
fields or any intrinsic field produced by simulations such as
@@ -85,11 +85,11 @@ simulated, and by analogy, observed data.
8585

8686
`EXP` decomposes a galaxy into multiple bases for a variety of scales
8787
and geometries and is thus able to represent arbitrarily complex
88-
simulation with many components (e.g., disk, bulge, dark matter halo,
88+
simulations with many components (e.g., disk, bulge, dark matter halo,
8989
satellites). `EXP` is able to efficiently summarize the degree and
9090
nature of asymmetries through coefficient amplitudes tracked through
9191
time and provide details at multiple scales. The
92-
amplitudes themselves enable ex-post-facto dynamical discovery.
92+
amplitudes themselves enable ex-post-facto dynamical discovery.
9393
`EXP` is a collection of object-oriented C++ libraries with an
9494
associated modular N-body code and a suite of stand-alone analysis
9595
applications.
@@ -106,11 +106,11 @@ coefficients and discover dynamical relationships using time series
106106
analysis such as mSSA. We provide a [full online
107107
manual](https://exp-docs.readthedocs.io) hosted by ReadTheDocs.
108108

109-
The software package brings published -- but difficult to implement --
110-
applied-math technologies into the astronomical mainstream. `EXP` and
109+
The software package brings published---but difficult to implement---applied-math
110+
technologies into the astronomical mainstream. `EXP` and
111111
the associated Python interface `pyEXP` accomplish this by providing
112112
tools integrated with the Python ecosystem, and in particular are
113-
well-suited for interactive Python [@iPython] use through (e.g.)
113+
well-suited for interactive Python [@iPython] use through, e.g.,
114114
Jupyter notebooks [@jupyter]. `EXP` serves as the
115115
scaffolding for new imaginative applications in galactic dynamics,
116116
providing a common dynamical language for simulations and analytic
@@ -126,36 +126,36 @@ computed bases and resulting coefficient data are stored in HDF5
126126

127127
| Name | Description |
128128
| ----------- | ------------- |
129-
| sphereSL | Sturm-Liouville basis function solutions to Poisson's equation for any arbitrary input spherical density |
129+
| sphereSL | Sturm--Liouville basis function solutions to Poisson's equation for any arbitrary input spherical density |
130130
| bessel | Basis constructed from eigenfunctions of the spherical Laplacian |
131131
| cylinder | EOF solutions tabulated on the meridional plane for distributions with cylindrical geometries |
132132
| flatdisk | EOF basis solutions for the three-dimensional gravitational field of a razor-thin disk |
133133
| cube | Trigonometric basis solution for expansions in a cube with boundary criteria |
134134
| field | General-purpose EOF solution for scalar profiles |
135135
| velocity | EOF solution for velocity flow coefficients |
136136

137-
![Example cylinder basis functions, where the color encodes the amplitude of the function, for an exponential disk with a scalelength of 3 and a scaleheight of 0.3 in arbitrary units. We select three functions at low, medium, and higher order (corresponding to the number of nodes). The color scale has been normalised such that the largest amplitude is unity in each panel. \label{fig:examplecylinder}](examplefunctions.png)
137+
![Example cylinder basis functions, where the color encodes the amplitude of the function, for an exponential disk with a scale length of 3 and a scale height of 0.3 in arbitrary units. We select three functions at low, medium, and higher order (corresponding to the number of nodes). The color scale has been normalised such that the largest amplitude is unity in each panel. \label{fig:examplecylinder}](examplefunctions.png)
138138

139139

140140
## N-body simulation
141141

142142
Computing the gravitational potential and forces from a collection of
143-
N particles is typically an expensive endeavour. EXP reduces the cost
143+
N particles is typically an expensive endeavour. `EXP` reduces the cost
144144
by using BFE to compute the potential and forces such that computational
145145
effort scales with the number of particles. Other modern N-body codes
146146
use direct summation [@Wang:15] or tree-based solutions [@Gadget4],
147147
which have computational effort that scales as N$^2$ and N log N,
148148
respectively. The trade off for BFE solutions comes in the form of
149-
restricted degrees of freedom; for many problems in near-equilibrium
149+
restricted degrees of freedom. For many problems in near-equilibrium
150150
galactic dynamics this is not a problem, but rather a feature.
151151

152152
Our design includes a wide choice of run-time summary diagnostics,
153153
phase-space output formats, dynamically loadable user libraries, and
154-
easy extensibility. Stand-alone routines include the EOF and mSSA
155-
methods described above, and the modular software architecture of
156-
`EXP` enables users to easily build and maintain extensions. The `EXP`
154+
easy extensibility. Stand-alone routines include the EOF and mSSA
155+
methods described above, and the modular software architecture of
156+
`EXP` enables users to easily build and maintain extensions. The `EXP`
157157
code base is described in published papers [@Petersen:22; @Weinberg:23]
158-
and has been used, enhanced, and rigorously tested for nearly two
158+
and has been used, enhanced, and rigorously tested for nearly two
159159
decades.
160160

161161

@@ -181,10 +181,10 @@ can be extended by users.
181181
`pyEXP` provides an interface to many of the classes in the `EXP` C++
182182
library, allowing for both the generation of all bases listed in the
183183
table above as well as coefficients for an input data set. Each of
184-
these tools are Python classes that accept `numpy` [@numpy] arrays for
185-
immediate interoperability with `matplotlib` [@matplotlib] and
184+
these tools are Python classes that accept NumPy [@numpy] arrays for
185+
immediate interoperability with Matplotlib [@matplotlib] and
186186
Astropy. We include a verified set of stand-alone routines that read
187-
phase-space files from many major cosmological tree codes [for example,
187+
phase-space files from many major cosmological tree codes [e.g.,
188188
@Gadget4] and produce
189189
BFE-based analyses. The code suite includes adapters for reading and
190190
writing phase space for many of the widely used cosmology codes, with
@@ -201,11 +201,11 @@ The `EXP` library includes multiple time series analysis tools,
201201
documented in the manual. Here, we briefly highlight one technique
202202
that we have already used in published work: mSSA [@Weinberg:21;
203203
@Johnson:23]. Beginning with coefficient series from the previous
204-
tools, mSSA summarizes signals _in time_ that describes dynamically
204+
tools, mSSA summarizes signals _in time_ that describe dynamically
205205
correlated responses and patterns. Essentially, this is BFE in time
206206
and space. These temporal and spatial patterns allow users to better
207207
identify dynamical mechanisms and enable intercomparisons and
208-
filtering for features in simulation suites; e.g. computing the
208+
filtering for features in simulation suites, e.g. computing the
209209
fraction galaxies with grand design structure or hosting
210210
bars. Random-matrix techniques for singular-value decomposition ensure
211211
that analyses of large data sets is possible. All mSSA decompositions
@@ -221,4 +221,3 @@ Robert Blackwell for invaluable help with HPC best practices.
221221

222222

223223
# References
224-

0 commit comments

Comments
 (0)