[PRE REVIEW]: CRNPy: An Open-Source Python Library for Cosmic Ray Neutron Probe Data Processing

[editorialbot]

Submitting author: @joaquinperaza (Joaquin Peraza Rud)
Repository: https://github.com/soilwater/crnpy
Branch with paper.md (empty if default branch): JOSS
Version: v0.5.1
Editor: @elbeejay
Reviewers: @jlarsen-usgs, @danpower101
Managing EiC: Kristen Thyng

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/e65c1bb5fee58c39289efc4547d1fd10"><img src="https://joss.theoj.org/papers/e65c1bb5fee58c39289efc4547d1fd10/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/e65c1bb5fee58c39289efc4547d1fd10/status.svg)](https://joss.theoj.org/papers/e65c1bb5fee58c39289efc4547d1fd10)

Author instructions

Thanks for submitting your paper to JOSS @joaquinperaza. Currently, there isn't a JOSS editor assigned to your paper.

@joaquinperaza if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.19 s (351.6 files/s, 170623.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                             8           3905              6          13118
JavaScript                      33           1013           1272           4924
SVG                              2             76              2           2203
Python                           6            383            570            629
Jupyter Notebook                 6              0           3365            378
Markdown                         6            118              0            202
TeX                              1             21              0            176
YAML                             2             11              6             58
XML                              1              0              0             38
CSS                              1              6              6             24
JSON                             1              0              0              1
-------------------------------------------------------------------------------
SUM:                            67           5533           5227          21751
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

[editorialbot]

Wordcount for paper.md is 1064

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.2136/vzj2017.04.0086 may be a valid DOI for title: Status and perspectives on the cosmic-ray neutron method for soil moisture estimation and other environmental science applications
- 10.1029/2009wr008726 may be a valid DOI for title: Nature’s neutron probe: Land surface hydrology at an elusive scale with cosmic rays
- 10.1002/2014wr016443 may be a valid DOI for title: An empirical vegetation correction for soil water content quantification using cosmic ray probes
- 10.1007/978-3-319-69539-6_2 may be a valid DOI for title: In Situ Destructive Sampling
- 10.22323/1.358.1149 may be a valid DOI for title: Re-examination of the First Five Ground-Level Events
- 10.1029/2008gl035655 may be a valid DOI for title: Measuring soil moisture content non-invasively at intermediate spatial scale using cosmic-ray neutrons
- 10.1029/2012wr011871 may be a valid DOI for title: Measurement depth of the cosmic ray soil moisture probe affected by hydrogen from various sources
- 10.3389/frwa.2020.00009 may be a valid DOI for title: Practical data products from cosmic-ray neutron sensing for hydrological applications
- 10.5194/hess-12-1323-2008 may be a valid DOI for title: From near-surface to root-zone soil moisture using an exponential filter: an assessment of the method based on in-situ observations and model simulations
- 10.1002/saj2.20319 may be a valid DOI for title: Predicting rootzone soil moisture from surface observations in cropland using an exponential filter
- 10.5194/egusphere-egu2020-8488 may be a valid DOI for title: Error estimation for soil moisture measurements with cosmic ray neutron sensing and implications for rover surveys

INVALID DOIs

- https://doi.org/10.1175/JHM-D-12-0120.1 is INVALID because of 'https://doi.org/' prefix

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[kthyng]

Hi @joaquinperaza and thanks for your submission. Because of the relatively small number of lines of Python code, I am going to ask the greater editorial board to consider if the package is in scope in terms of the substantial scholarly effort. This process will take 1-2 weeks. Thanks.

[kthyng]

@editorialbot query scope

[editorialbot]

Submission flagged for editorial review.

[joaquinperaza]

Thank you for your prompt response and valuable feedback on our manuscript submission to the Journal of Open Source Software. We appreciate the diligence of the editorial board in evaluating our work. We would like to provide some additional context regarding our CRNPy library and address the concerns raised:

CRNPy is a comprehensive library encompassing the full spectrum of routines required for the correction and analysis of raw cosmic-ray neutron data recorded by both stationary and roving devices for soil moisture monitoring. It is noteworthy that the CRNPy library incorporates, to the best of our knowledge, nearly all existing techniques and methods in this field. This collective effort is reflected in the inclusion of methods documented across 12 peer-reviewed manuscripts spanning the past 15 years since the inception of this technique. This extensive body of work underscores the completeness and robustness of our library.

Recognizing the constraints posed by the specified limit on the total lines of code in the main file, we have gone the extra mile to create three comprehensive tutorials in the form of Jupyter Notebooks that include additional Python code and are designed to facilitate the onboarding of new users, including scientists, graduate students, and lab/field technicians. These tutorials utilize real-world data and cover a range of sensor manufacturers, ensuring that users can harness the full potential of CRNPy with ease.

We want to reassure the editorial board of our commitment to aligning with the journal's requirements and guidelines. Should there be any further questions, suggestions, or specific modifications needed to accommodate our submission, we are fully prepared to collaborate closely with the editorial office to ensure that our work meets the standards set forth by the Journal of Open Source Software.

Once again, thank you for your consideration, and we look forward to any further guidance you may provide.

[kthyng]

Thank you for the extra information! I'll make sure the editors see it.

[kthyng]

@joaquinperaza Ok the submission was deemed in scope while being small. Unfortunately our editorial board is maxed out so I need to now add this to our waitlist. Thanks for your patience.

[joaquinperaza]

Thank you for the update. We'll wait for more instructions and are ready to help as needed. I appreciate your efforts.

[kthyng]

@joaquinperaza what sort of background would be good for an editor to have for this submission? I am having trouble seeing where and with whom it might fit in with.

[joaquinperaza]

@kthyng the ideal editor for this submission should have a strong background in hydrology and environmental soil physics with expertise in the field of soil moisture sensing.

[kthyng]

@elbeejay Are you up for editing this submission?

[kthyng]

@editorialbot invite @elbeejay as editor

[editorialbot]

Invitation to edit this submission sent!

[elbeejay]

@editorialbot assign @elbeejay as editor

[editorialbot]

Assigned! @elbeejay is now the editor

[elbeejay]

@joaquinperaza I will have a look through the repository and paper later this week and get back to you with any minor comments on my end. In the meantime, are there any reviewers you might want to recommend for this work? Please consult with co-authors and check out our list of volunteers to make that determination.

Thanks

[joaquinperaza]

@elbeejay Thanks for taking the time to look at our research. From the volunteer list, Dr. Shu and Joshua Larsen have demonstrated experience in soil science and hydrology.

If it would be of assistance, we can recommend researchers on the topic of cosmic-ray neutron detection. If this aligns with the review process, could you kindly let us know what information would you require? We appreciate your guidance on this.

[elbeejay]

Thanks @joaquinperaza - we'd want to know their GitHub handle, which you could provide here without the "@" so joaquinperaza for you for example. Thank you for checking our list of volunteers, if you think of anyone else from the field that'd be a good fit please let me know.

[elbeejay]

@joaquinperaza I took a look at the paper and the repository and it all looks fine to me, I think we can send it out for review so I'll be contacting potential reviewers now.

[elbeejay]

@shulele and @jlarsen-usgs would either of you be interested in reviewing this submission to the Journal of Open Source Software (JOSS) titled "CRNPy: An Open-Source Python Library for Cosmic Ray Neutron Probe Data Processing"? You were both recommended as potential reviewers by the submitting author. I recognize this may not be your precise field of expertise, so if you are unable or uncomfortable to provide a review, please suggest colleagues who may be better suited.

At JOSS we do open checklist-driven reviews; peer-review criteria can be viewed here. This issue is a "pre-review issue" which we use to find peer-reviewers. Once 3 reviewers are found, we will officially start the review in a dedicated GitHub issue. At present we are asking reviewers to complete reviews in 6 weeks, although this can be extended if needed. If you are not able to review but can recommend someone else, please mention them here (in this case please mention their GitHub handle without the "@" symbol).

If you are interested, please take a look at the journal's conflict of interest policy to ensure you do not have a conflict before agreeing to review this submission.

Thanks again for taking a moment to consider this, feel free to contact me if you have any questions about the JOSS review process. Please do not feel any pressure to accept this review request if you do not have the time or do not feel comfortable reviewing this software package, we appreciate and respect our peer-reviewers' time. If you cannot serve as a reviewer at this time but have a peer, collaborator, student, or colleague who might be available and would be a good fit for this submission, please let me know! If interested we can figure out how to set up a "co-review" for a colleague of yours that is a more junior or inexperienced member of the community.

Thanks for your consideration,
Jay

[jlarsen-usgs]

@elbeejay, I took a look through the repo and the paper and I'm interested in doing a review of this submission.

[elbeejay]

@editorialbot add @jlarsen-usgs as reviewer

Awesome thanks @jlarsen-usgs, adding you as a reviewer now, the review will officially kick-off in a separate issue once we confirm a second reviewer.

[editorialbot]

@jlarsen-usgs added to the reviewers list!

[elbeejay]

Hi @jeffskwang and @awickert, would either of you be interested in reviewing this submission to JOSS titled "CRNPy: An Open-Source Python Library for Cosmic Ray Neutron Probe Data Processing"? I realize this might not be a perfect fit for you so I'd be equally appreciative of any recommendations of colleagues you think might be good reviewers for this submission.

At JOSS we do open checklist-driven reviews; peer-review criteria can be viewed here. This issue is a "pre-review issue" which we use to find peer-reviewers. Once 3 reviewers are found, we will officially start the review in a dedicated GitHub issue. At present we are asking reviewers to complete reviews in 6 weeks, although this can be extended if needed. If you are not able to review but can recommend someone else, please mention them here (in this case please mention their GitHub handle without the "@" symbol).

If you are interested, please take a look at the journal's conflict of interest policy to ensure you do not have a conflict before agreeing to review this submission.

Thanks again for taking a moment to consider this, feel free to contact me if you have any questions about the JOSS review process. Please do not feel any pressure to accept this review request if you do not have the time or do not feel comfortable reviewing this software package, we appreciate and respect our peer-reviewers' time. If you cannot serve as a reviewer at this time but have a peer, collaborator, student, or colleague who might be available and would be a good fit for this submission, please let me know! If interested we can figure out how to set up a "co-review" for a colleague of yours that is a more junior or inexperienced member of the community.

I hope you both are well and thanks for your consideration,
Jay

[awickert]

Hi @elbeejay,

Thanks for the note. I just looked into the package, and (other than a brief memory of seeing a poster at AGU) I have no experience with cosmogenic radionuclides used as soil-moisture sensor. This unfortunately means that I have no idea whom I could recommend to you: so sorry!

With cheer and good wishes to find a referee,
Andy

[jeffskwang]

Hello @elbeejay,
It's nice to hear from you. Like Andy, I don't have any experience whatsoever with this science, so I don't think I'd make a good reviewer. Also, I'm not aware of any of my colleagues that are working on this problem.

Did you see: https://github.com/danpower101/crspy? Maybe someone on that project would be good?

Jeffrey

[elbeejay]

@danpower101 would you be interested in reviewing this submission to JOSS titled "CRNPy: An Open-Source Python Library for Cosmic Ray Neutron Probe Data Processing"? As you can see in the comment above, your project crspy was mentioned as it appears to fall in the same field as the CRNPy software submitted here. With that being said, it seemed like you might be a good fit as a reviewer, and we'd definitely appreciate your input and expertise. Below is some information about the journal and review process, please do not hesitate to reach out if you are unsure about anything and have any questions.

At JOSS we do open checklist-driven reviews; peer-review criteria can be viewed here. This issue is a "pre-review issue" which we use to find peer-reviewers. Once 3 reviewers are found, we will officially start the review in a dedicated GitHub issue. At present we are asking reviewers to complete reviews in 6 weeks, although this can be extended if needed. If you are not able to review but can recommend someone else, please mention them here (in this case please mention their GitHub handle without the "@" symbol).

If you are interested, please take a look at the journal's conflict of interest policy to ensure you do not have a conflict before agreeing to review this submission.

Thanks again for taking a moment to consider this, feel free to contact me if you have any questions about the JOSS review process. Please do not feel any pressure to accept this review request if you do not have the time or do not feel comfortable reviewing this software package, we appreciate and respect our peer-reviewers' time. If you cannot serve as a reviewer at this time but have a peer, collaborator, student, or colleague who might be available and would be a good fit for this submission, please let me know!

Thanks,
Jay

[danpower101]

Hi @elbeejay

I've had a look through the paper/repo and I'd be happy to review it.

Thanks,
Dan

[elbeejay]

@editorialbot add @danpower101 as reviewer

Great, thanks @danpower101

[editorialbot]

@danpower101 added to the reviewers list!

[elbeejay]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #6025.