From c7f59733224f316fb880268752f4ef7e8d1e9330 Mon Sep 17 00:00:00 2001 From: murphyqm Date: Mon, 14 Dec 2020 19:29:43 +0000 Subject: [PATCH 1/2] Final additions to instructions and citation file --- CITATION.cff | 13 +++++++++++++ CITATION.txt | 18 ++++++++++++++++++ README.md | 17 +++++++++++++++++ 3 files changed, 48 insertions(+) create mode 100644 CITATION.txt diff --git a/CITATION.cff b/CITATION.cff index 4481c0a..db1c921 100644 --- a/CITATION.cff +++ b/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: diff --git a/CITATION.txt b/CITATION.txt new file mode 100644 index 0000000..0a9f385 --- /dev/null +++ b/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}, +} diff --git a/README.md b/README.md index 8e3bc38..6400726 100644 --- a/README.md +++ b/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 -------- From 5ba3a38229734e6fc4a7a0fd6b575a6801ee31ba Mon Sep 17 00:00:00 2001 From: murphyqm Date: Mon, 14 Dec 2020 19:36:07 +0000 Subject: [PATCH 2/2] Fix md linting error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6400726..7d1d850 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ To run a case with default parameters: See the Jupyter notebooks provided for working examples. -**To download data from NGDC and plot it:** +**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: