-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
|
||
--- | ||
title: 'PolarToolkit: Python Tools for Conducting Polar Science' | ||
tags: | ||
- python | ||
- cryosphere | ||
- polar | ||
- antarctica | ||
- arctic | ||
- greenland | ||
- open science | ||
authors: | ||
- name: Matthew D. Tankersley | ||
orcid: 0000-0003-4266-8554 | ||
affiliation: "1, 2" | ||
affiliations: | ||
- name: Victoria University of Wellington, New Zealand | ||
index: 1 | ||
- name: GNS Science, New Zealand | ||
index: 2 | ||
<!-- date: 13 August 2017 --> | ||
bibliography: paper.bib | ||
--- | ||
|
||
<!-- Title options: | ||
PolarToolkit: Python Tools for Conducting Polar Science | ||
Cryospheric Insights Made Easy: Exploring PolarToolkit for Polar Studies | ||
PolarToolkit: A Comprehensive Software Suite for Antarctic Research | ||
PolarToolkit: Software for Cryospheric Mapping, Analysis, and Data Retrieval | ||
PolarToolkit: Software to Aide in Cryospheric Research | ||
PolarToolkit: Facilitating Cryospheric Research with Open-Source Software --> | ||
|
||
# Summary | ||
|
||
|
||
# Statement of need | ||
|
||
|
||
`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 | ||
designed to provide a class-based and user-friendly interface to fast (C or | ||
Cython-optimized) implementations of common operations such as gravitational | ||
potential and force evaluation, orbit integration, dynamical transformations, | ||
and chaos indicators for nonlinear dynamics. `Gala` also relies heavily on and | ||
interfaces well with the implementations of physical units and astronomical | ||
coordinate systems in the `Astropy` package [@astropy] (`astropy.units` and | ||
`astropy.coordinates`). | ||
|
||
`Gala` was designed to be used by both astronomical researchers and by | ||
students in courses on gravitational dynamics or astronomy. It has already been | ||
used in a number of scientific publications [@Pearson:2017] and has also been | ||
used in graduate courses on Galactic dynamics to, e.g., provide interactive | ||
visualizations of textbook material [@Binney:2008]. The combination of speed, | ||
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. | ||
|
||
|
||
# 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: | ||
![Caption for example figure.\label{fig:example}](figure.png) | ||
and referenced from text using \autoref{fig:example}. | ||
|
||
Figure sizes can be customized by adding an optional second parameter: | ||
![Caption for example figure.](figure.png){ width=20% } | ||
|
||
# Acknowledgements | ||
|
||
We acknowledge contributions from Brigitta Sipocz, Syrtis Major, and Semyeong | ||
Oh, and support from Kathryn Johnston during the genesis of this project. | ||
|
||
WeiJi, PyGMT, Fatiando a Terra, Software Underground, | ||
# References |