Merge pull request #28 from murphyqm/release-version-1

Release version 1

CITATION.cff

@@ -11,8 +11,21 @@ authors:
     family-names: Walker
     given-names: Andrew
   -
+    affiliation: "University of Leeds"
     family-names: Davies
     given-names: "Christopher J."
+  -
+    affiliation: "University of Leeds"
+    family-names: Mound
+    given-names: "Jonathan E."
+  -
+    affiliation: "Georg-August-University Göttingen"
+    family-names: Mueller
+    given-names: Thomas
+  -
+    affiliation: "University of Leeds"
+    family-names: Harvey
+    given-names: Jason
 cff-version: "1.1.0"
 doi: "10.1002/essoar.10504913.1"
 keywords: 

CITATION.txt

@@ -0,0 +1,18 @@
+Citation
+========
+
+If you use our model, please cite our preprint:
+
+Murphy Quinlan, M., Walker, A., Davies, C. J., Mound, J. E., Müller, T., & Harvey, J. (2020). The conductive cooling of planetesimals with temperature-dependent properties. Earth and Space Science Open Archive, Wiley. https://doi.org/10.1002/essoar.10504913.1 
+
+BibTex:
+
+@article{MurphyQuinlan2020, 
+author = {Murphy Quinlan, Maeve and Walker, Andrew and Davies, Christopher J. and Mound, Jonathan E. and Müller, Thomas and Harvey, Jason}, 
+title = {The conductive cooling of planetesimals with temperature-dependent properties}, 
+journal = {Earth and Space Science Open Archive}, 
+pages = {24}, 
+year = {2020}, 
+DOI = {10.1002/essoar.10504913.1}, 
+url = {https://doi.org/10.1002/essoar.10504913.1}, 
+}

README.md

@@ -9,6 +9,9 @@ In 1D, it must satisfy Von Neumann stability analysis - please see [Murphy Quinl
 
 The code currently recreates the cases described in [Murphy Quinlan et al. (2020 - preprint)](https://www.essoar.org/doi/abs/10.1002/essoar.10504913.1). References for the default parameters used can be found therein. We plan to extend it and make it more modular in future updates.
 
+Quick Start
+-----------
+
 To run a case with default parameters:
 
     from modular_cond_cooling import conductive_cooling
@@ -24,6 +27,20 @@ To run a case with default parameters:
 
 See the Jupyter notebooks provided for working examples.
 
+**To download data from NGDC and plot it:**
+
+Navigate to the `downloading_and_plotting_data` directory. From the command line, run the required script to download the .dat files from the NGDC:
+
+`$ python downloaddata.py`
+
+Once the data is downloaded from the NGDC, it is available to plot using `coolingplot.py` with the filename you wish to plot:
+
+`$ python coolingplot.py constant_properties.dat`
+
+For more information run:
+
+`$ python coolingplot.py -h`
+
 Features
 --------