Skip to content

Commit

Permalink
Added how to cite to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Liam Kilcommons committed Jul 3, 2019
1 parent 5f34856 commit 0612f0d
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Identify boundaries of the aurora with Defense Meteorology Satellite Program (DM

[![Documentation Status](https://readthedocs.org/projects/ssj-auroral-boundary/badge/?version=latest)](https://ssj-auroral-boundary.readthedocs.io/en/latest/?badge=latest)

## How to cite

Cite the Zenodo DOI (above) for the code
Cite the paper (below) for the algorithm

## Algorithm

This code implements the auroral boundary identification technique described in:
Expand All @@ -13,6 +18,7 @@ Kilcommons, L. M., Redmon, R. J., & Knipp, D. J. (2017). A New DMSP Magnetometer

## Tested Operating Systems
* Ubuntu Linux (14.04 and 18.04)
* MacOS (Sierra, High Sierra)

## Tested Python Versions
* 2.7 (Anaconda2)
Expand All @@ -28,8 +34,7 @@ files. An additional Python package (Spacepy) provides the python interface.

2. [Geospacepy](https://github.com/lkilcommons/geospacepy-lite)
This is a small python package which provides plotting routines and datetime
handling. The installation instructions are on the Github page. Hopefully
soon it will be on PyPI but it hasn't happened yet.
handling. The installation instructions are on the Github page.

## Clone the github repo
```
Expand Down

0 comments on commit 0612f0d

Please sign in to comment.