Skip to content

Commit

Permalink
updated paper draft
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelweinold committed Sep 28, 2023
1 parent dd7405d commit b3a7f5d
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 126 deletions.
102 changes: 33 additions & 69 deletions joss/paper.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,52 @@
---
title: 'Gala: A Python package for galactic dynamics'
title: 'Brightway Live: Complet Life-Cycle Assessment Calculations in the Browser'
tags:
- Python
- astronomy
- dynamics
- galactic dynamics
- milky way
- Brightway
- sustainability
- lca
- life-cycle assessment
- teaching
authors:
- name: Adrian M. Price-Whelan
orcid: 0000-0000-0000-0000
equal-contrib: true
affiliation: "1, 2" # (Multiple affiliations must be quoted)
- name: Author Without ORCID
equal-contrib: true # (This is how you can denote equal contributions between multiple authors)
- name: Michael Weinold
orcid: 0000-0003-4859-2650
equal-contrib: false
affiliation: 1
- name: Christopher Mutel
orcid: 0000-0002-7898-9862
equal-contrib: false
affiliation: 2
- name: Author with no affiliation
corresponding: true # (This is how to denote the corresponding author)
affiliation: 3
- given-names: Ludwig
dropping-particle: van
surname: Beethoven
affiliation: 3
affiliations:
- name: Lyman Spitzer, Jr. Fellow, Princeton University, USA
- name: Technology Assessment Group, Paul Scherrer Institute, Villigen, Switzerland
index: 1
- name: Institution Name, Country
- name: Ecoinvent Association, Zurich, Switzerland
index: 2
- name: Independent Researcher, Country
index: 3
date: 13 August 2017
date: 25 September 2023
bibliography: references.bib

# Optional fields if submitting to a AAS journal too, see this blog post:
# https://blog.joss.theoj.org/2018/12/a-new-collaboration-with-aas-publishing
aas-doi: 10.3847/xxxxx <- update this with the DOI from AAS once you know it.
aas-journal: Astrophysical Journal <- The name of the AAS journal.
---

# Summary

The forces on stars, galaxies, and dark matter under external gravitational
fields lead to the dynamical evolution of structures in the universe. The orbits
of these bodies are therefore key to understanding the formation, history, and
future state of galaxies. The field of "galactic dynamics," which aims to model
the gravitating components of galaxies to study their structure and evolution,
is now well-established, commonly taught, and frequently used in astronomy.
Aside from toy problems and demonstrations, the majority of problems require
efficient numerical tools, many of which require the same base code (e.g., for
performing numerical orbit integration).
Life-cycle assessment has become a uibiquitous tool in decision making.
It is used in industry, policy and every day economic transactions.
The number of students required to learn it has grown rapidly over the past year.
While some well-established software packages exist, some are proprietary, limiting their use in a teaching environment.
The open source Brightway software framework is a popular choice for teaching, but requires installation on a local computer.
Experience has shown that the setup (local Python environment, matching versions, etc.) can take many man-hours.


Even with

# Statement of need

`Brightway Live` is an implementation of the JupyterLite distribution
of the JupyterLab web-based interactive development environment.
It provides WASM support for the Brightway life-cycle assessment software framework `[Mutel_2017]`.
It works with other Brightway packages, such as `Temporalis` `[Cardellini_2018]`.

`Brightway Live` was designed to be used in a teaching environment. With increases in performance of Python in WASM...

`Gala` is an Astropy-affiliated Python package for galactic dynamics. Python
enables wrapping low-level languages (e.g., C) for speed without losing
flexibility or ease-of-use in the user-interface. The API for `Gala` was
Expand All @@ -71,37 +67,6 @@ design, and support for Astropy functionality in `Gala` will enable exciting
scientific explorations of forthcoming data releases from the *Gaia* mission
[@gaia] by students and experts alike.

# Mathematics

Single dollars ($) are required for inline mathematics e.g. $f(x) = e^{\pi/x}$

Double dollars make self-standing equations:

$$\Theta(x) = \left\{\begin{array}{l}
0\textrm{ if } x < 0\cr
1\textrm{ else}
\end{array}\right.$$

You can also use plain \LaTeX for equations
\begin{equation}\label{eq:fourier}
\hat f(\omega) = \int_{-\infty}^{\infty} f(x) e^{i\omega x} dx
\end{equation}
and refer to \autoref{eq:fourier} from text.

# Citations

Citations to entries in paper.bib should be in
[rMarkdown](http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html)
format.

If you want to cite a software repository URL (e.g. something on GitHub without a preferred
citation) then you can do it with the example BibTeX entry below for @fidgit.

For a quick reference, the following citation commands can be used:
- `@author:2001` -> "Author et al. (2001)"
- `[@author:2001]` -> "(Author et al., 2001)"
- `[@author1:2001; @author2:2001]` -> "(Author1 et al., 2001; Author2 et al., 2002)"

# Figures

Figures can be included like this:
Expand All @@ -113,7 +78,6 @@ Figure sizes can be customized by adding an optional second parameter:

# Acknowledgements

We acknowledge contributions from Brigitta Sipocz, Syrtis Major, and Semyeong
Oh, and support from Kathryn Johnston during the genesis of this project.
We gratefully acknowledge helpful conversations and contributions from the developers of [the Pyodide project](https://github.com/pyodide/), the [Emscripten Forge project](https://github.com/emscripten-forge), [the Jupyter Xeus project](https://github.com/jupyter-xeus) and [the JupyterLite project](https://github.com/jupyterlite). Michael Weinold gratefully acknowledges funding from the Swiss Innovation Agency Innosuisse through the WISER flagship project.

# References
81 changes: 24 additions & 57 deletions joss/references.bib
Original file line number Diff line number Diff line change
@@ -1,59 +1,26 @@
@article{Pearson:2017,
url = {http://adsabs.harvard.edu/abs/2017arXiv170304627P},
Archiveprefix = {arXiv},
Author = {{Pearson}, S. and {Price-Whelan}, A.~M. and {Johnston}, K.~V.},
Eprint = {1703.04627},
Journal = {ArXiv e-prints},
Keywords = {Astrophysics - Astrophysics of Galaxies},
Month = mar,
Title = {{Gaps in Globular Cluster Streams: Pal 5 and the Galactic Bar}},
Year = 2017
@article{Mutel_2017,
doi = {10.21105/joss.00236},
url = {https://doi.org/10.21105\%2Fjoss.00236},
year = 2017,
month = {apr},
publisher = {The Open Journal},
volume = {2},
number = {12},
pages = {236},
author = {Chris Mutel},
title = {Brightway: An open source framework for Life Cycle Assessment},
journal = {The Journal of Open Source Software}
}

@book{Binney:2008,
url = {http://adsabs.harvard.edu/abs/2008gady.book.....B},
Author = {{Binney}, J. and {Tremaine}, S.},
Booktitle = {Galactic Dynamics: Second Edition, by James Binney and Scott Tremaine.~ISBN 978-0-691-13026-2 (HB).~Published by Princeton University Press, Princeton, NJ USA, 2008.},
Publisher = {Princeton University Press},
Title = {{Galactic Dynamics: Second Edition}},
Year = 2008
}

@article{gaia,
author = {{Gaia Collaboration}},
title = "{The Gaia mission}",
journal = {Astronomy and Astrophysics},
archivePrefix = "arXiv",
eprint = {1609.04153},
primaryClass = "astro-ph.IM",
keywords = {space vehicles: instruments, Galaxy: structure, astrometry, parallaxes, proper motions, telescopes},
year = 2016,
month = nov,
volume = 595,
doi = {10.1051/0004-6361/201629272},
url = {http://adsabs.harvard.edu/abs/2016A%26A...595A...1G},
}

@article{astropy,
author = {{Astropy Collaboration}},
title = "{Astropy: A community Python package for astronomy}",
journal = {Astronomy and Astrophysics},
archivePrefix = "arXiv",
eprint = {1307.6212},
primaryClass = "astro-ph.IM",
keywords = {methods: data analysis, methods: miscellaneous, virtual observatory tools},
year = 2013,
month = oct,
volume = 558,
doi = {10.1051/0004-6361/201322068},
url = {http://adsabs.harvard.edu/abs/2013A%26A...558A..33A}
}

@misc{fidgit,
author = {A. M. Smith and K. Thaney and M. Hahnel},
title = {Fidgit: An ungodly union of GitHub and Figshare},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/arfon/fidgit}
@article{Cardellini_2018,
doi = {10.21105/joss.00612},
url = {https://doi.org/10.21105\%2Fjoss.00612},
year = 2018,
month = {apr},
publisher = {The Open Journal},
volume = {3},
number = {24},
pages = {612},
author = {Giuseppe Cardellini and Chris Mutel},
title = {Temporalis: an open source software for dynamic {LCA}},
journal = {Journal of Open Source Software}
}

0 comments on commit b3a7f5d

Please sign in to comment.