[PRE REVIEW]: reflectorch: a deep learning package for X-ray and neutron reflectometry

[editorialbot]

Submitting author: @valentinsingularity (Valentin Munteanu)
Repository: https://github.com/schreiber-lab/reflectorch
Branch with paper.md (empty if default branch):
Version: v1.2.1
Editor: @likeajumprope
Reviewers: @turnerjennings, @thomashopkins32, @rachitanaik-lyft
Managing EiC: Chris Vernon

Status

Status badge code:

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

Author instructions

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

@valentinsingularity 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]

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

OK DOIs

- 10.1051/jphysrad:01950001107030700 is OK
- 10.1107/s1600576724002115 is OK
- 10.1107/S160057752300749X is OK
- 10.1107/S1600576722002230 is OK
- 10.1107/S1600576724001171 is OK
- 10.1107/S1600576722006653 is OK
- 10.1107/S1600576718017296 is OK
- 10.5281/ZENODO.4329338 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.26 s (1458.8 files/s, 272812.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                            47           7973            191          21802
YAML                           149           1071           1834          12941
Python                          89           2076           1069           7105
CSS                             12            809            113           2904
PO File                         45           1007              0           2284
JavaScript                      16            197            299           1279
Jupyter Notebook                 4              0           4484            428
Markdown                         4             67              0            181
TeX                              1              8              0            101
CSV                              1              0              0             98
TOML                             1              5              0             53
SVG                              6              0              1             30
Dockerfile                       1              4              0              9
reStructuredText                 1              1             75              2
-------------------------------------------------------------------------------
SUM:                           377          13218           8066          49217
-------------------------------------------------------------------------------

Commit count by author:

   267	Valentin Munteanu
   169	Vladimir Starostin
    16	valentinsingularity
     7	StarostinV
     7	cvoelt
     3	Anastasia Ragulskaya
     1	constantin

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1244

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: MIT License (Valid open source OSI approved license)

[editorialbot]

⚠️ An error happened when generating the pdf. Author (Dmitry Lapkin) is missing affiliation.

[valentinsingularity]

@editorialbot commands

[editorialbot]

Hello @valentinsingularity, here are the things you can ask me to do:

# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers

[valentinsingularity]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

xrdfit: A Python package for fitting synchrotron X-ray diffraction spectra
Submitting author: @merrygoat
Handling editor: @jgostick (Active)
Reviewers: @KedoKudo, @mikapfl
Similarity score: 0.7135

Reel1.0 - A visualization tool for evaluating powder diffraction refinements
Submitting author: @fgjorup
Handling editor: @rkurchin (Active)
Reviewers: @cmbiwer, @mikapfl
Similarity score: 0.7117

xtal2png: A Python package for representing crystal structure as PNG files
Submitting author: @sgbaird
Handling editor: @rkurchin (Active)
Reviewers: @dandavies99, @PeterKraus
Similarity score: 0.7100

islatu: A Python package for the reduction of reflectometry data
Submitting author: @RBrearton
Handling editor: @jgostick (Active)
Reviewers: @andyfaff, @daguiam
Similarity score: 0.6983

Lightshow: a Python package for generating computational x-ray absorption spectroscopy input files
Submitting author: @matthewcarbone
Handling editor: @ppxasjsm (Active)
Reviewers: @maurov, @larsenkg
Similarity score: 0.6949

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[crvernon]

@editorialbot invite @likeajumprope as editor

👋 @likeajumprope this sounds like one you may wish to edit. Can you take this one on?

[editorialbot]

Invitation to edit this submission sent!

[crvernon]

Just following back up on this one @likeajumprope ...

👋 @likeajumprope this sounds like one you may wish to edit. Can you take this one on?

[likeajumprope]

Just following back up on this one @likeajumprope ...

👋 @likeajumprope this sounds like one you may wish to edit. Can you take this one on?

Ah sure - apologies I have been on summer leave

[likeajumprope]

@editorialbot assign me as editor

[editorialbot]

Assigned! @likeajumprope is now the editor

[crvernon]

No problem @likeajumprope and thank you!!

[likeajumprope]

Hi @GarrettMerz - based on your expertise, would you be willing to take on this paper for JOSS?

[likeajumprope]

Hi @Saran-nns - based on your expertise, would you be willing to take on this paper for JOSS?

[crvernon]

@likeajumprope let me know if you would like my help in trying to get some reviewers set up for this submission.

[likeajumprope]

@likeajumprope let me know if you would like my help in trying to get some reviewers set up for this submission.

that would be fantastic @crvernon I have been struggling with this one

[Saran-nns]

Hi @likeajumprope Sorry for the delay. I'm quite occupied with deadlines for next 4 months. Thanks for understanding 🙏🏽

[crvernon]

👋 @tacaswell - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

[crvernon]

👋 @turnerjennings - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

[crvernon]

👋 @rachitanaik-lyft - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

[turnerjennings]

👋 @turnerjennings - Would you be willing to review this submission to JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

@crvernon Happy to review this submission! This is my first review with JOSS so bear with me while I figure out the format.

[crvernon]

@editorialbot add @turnerjennings as reviewer

Thanks and no problem at all! Once I get one more reviewer assigned, @likeajumprope or I will start the formal review thread and provide instructions there.

[editorialbot]

@turnerjennings added to the reviewers list!

[rachitanaik-lyft]

Hi @crvernon! I don't have domain knowledge about X-ray and neutron reflectometry - is that a requirement?

[crvernon]

👋 @rachitanaik-lyft - not in this case, I chose you because I believe you have a good understanding of the processes underlying these types of packages with respect to deep learning. Does that sound OK? If so, I will add you as a reviewer.

[tacaswell]

I am not able to review right now, but nominate my co-worker @thomashopkins32 in my place.

[crvernon]

@editorialbot add @thomashopkins32 as reviewer

[editorialbot]

@thomashopkins32 added to the reviewers list!

[crvernon]

@editorialbot add @rachitanaik-lyft as reviewer

[editorialbot]

@rachitanaik-lyft added to the reviewers list!

[crvernon]

@editorialbot start review

👋 Thank you for volunteering to review @turnerjennings, @thomashopkins32, and @rachitanaik-lyft !

I'll kick off the review thread now which will give you instructions for how to generate your review checklist, etc.

(cc: @likeajumprope)

[editorialbot]

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