Update paper.md - Githubissues

brmather / pycurious

Python package for computing the Curie depth from the magnetic anomaly

https://brmather.github.io/pycurious/

GNU Lesser General Public License v3.0

38 stars 17 forks source link

Update paper.md #31

Closed lheagy closed 5 years ago

lheagy commented 5 years ago

A few grammatical updates to the paper for the JOSS submission openjournals/joss-reviews#1544

I have a couple more requests / suggestions on the content:

Would you mind adding a sentence or two in the first paragraph that explains the importance of the Curie depth to a more general audience? JOSS readers come from a variety of backgrounds, so having a statement or two explaining its significance will make it more accessible
the "Documentation" and "Installation / Usage" are a bit more suited to the README than the JOSS paper. You can keep them if you wish, but I would recommend that they be condensed under one section if that is the case.
not required, but many papers include an image that gives users a bit of a sense of the data or workflow that the software is tailored for. If you have one, feel free to include it
I have left a couple more specific comments in the text.

Thanks!

brmather commented 5 years ago

Thanks @lheagy for reading through the paper and suggesting revisions. I have added a commit to your PR that I think addresses your comments:

Better description of the temperature inference from geophysical data are why Curie depth estimation is an important contribution to this field. Also included another reference.
Documentation and installation instructions have been condensed. Just the documentation is outlined, installation is better suited to the README as you say.
I have included a figure where the radial power spectrum has been computed over different sized square windows of a synthetic magnetic anomaly.
Broken each sentence into a separate line to make any future edits much easier to compare.

Please feel free to add/modify anything. I appreciate your feedback.

Thanks!

brmather commented 5 years ago

Also, quick question - is it possible to format references using citep / citet styles? For example the text:

pycurious implements the (Tanaka, Okubo, & Matsubayashi, 1999) and (Bouligand, Glen, & Blakely, 2009) methods for computing the thickness of a buried magnetic source.

would look much better if it was formatted:

pycurious implements the Tanaka et al. (1999) and Bouligand et al. (2009) methods for computing the thickness of a buried magnetic source.

Do you know if this is possible?

lheagy commented 5 years ago

Yep, you can use the following for formatting citations

- `@author:2001`  ->  "Author et al. (2001)"
- `[@author:2001]` -> "(Author et al., 2001)"
- `[@author1:2001; @author2:2001]` -> "(Author1 et al., 2001; Author2 et al., 2002)"

brmather commented 5 years ago

Thanks @lheagy for your suggestions - they are incorporated in the main text. I found that whedon didn't like the colons in the references but when I removed them it compiled correctly.

The PDF looks quite good now! If you have no further revisions, then I will merge this pull request to the master branch.

brmather commented 5 years ago

Quick update: I updated the image caption with a richer description of what's going on. Cheers!