[PRE REVIEW]: eo-tides: Tide modelling tools for large-scale satellite Earth observation analysis

[editorialbot]

Submitting author: @robbibt (Robbi Bishop-Taylor)
Repository: https://github.com/GeoscienceAustralia/eo-tides
Branch with paper.md (empty if default branch):
Version: 0.5.0
Editor: Pending
Reviewers: Pending
Managing EiC: Kristen Thyng

Status

Status badge code:

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

Author instructions

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

@robbibt 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.5281/zenodo.5555395 is OK
- 10.5281/zenodo.3509134 is OK
- 10.25080/Majora-92bf1922-00a is OK
- 10.5334/jors.148 is OK
- 10.26186/145234 is OK
- 10.26186/149403 is OK
- 10.21105/joss.06683 is OK
- 10.1016/j.rse.2021.112734 is OK
- 10.1016/j.ecss.2019.03.006 is OK
- 10.3390/rs10030480 is OK
- 10.1017/cft.2022.4 is OK
- 10.1016/j.coastaleng.2021.103919 is OK
- 10.1016/j.envsoft.2019.104528 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: opendatacube/odc-geo
- No DOI given, and none found for title: A new barotropic tide model for global ocean: FES2...
- No DOI given, and none found for title: SpatioTemporal Asset Catalog (STAC) specification

❌ MISSING DOIs

- 10.3390/rs4113417 may be a valid DOI for title: Continental scale mapping of tidal flats across Ea...
- 10.1016/j.rse.2017.04.009 may be a valid DOI for title: Extracting the intertidal extent and topography of...
- 10.1016/j.rse.2013.12.019 may be a valid DOI for title: Estuarine suspended particulate matter concentrati...
- 10.2139/ssrn.4858713 may be a valid DOI for title: What time is the tide? The importance of tides for...

❌ INVALID DOIs

- https://doi.org/10.1002/gdj3.174 is INVALID because of 'https://doi.org/' prefix

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.07 s (626.4 files/s, 319579.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              2              0              0           8789
Python                          12            577           1522           2280
Jupyter Notebook                 7              0           6981           1318
Markdown                        12            366              3            689
YAML                             7             48             37            344
TeX                              1             20              0            205
TOML                             1             13              0            119
make                             1             16              8             81
CSS                              1              3              3             20
Dockerfile                       1              6              6              9
INI                              1              1              0              4
-------------------------------------------------------------------------------
SUM:                            46           1050           8560          13858
-------------------------------------------------------------------------------

Commit count by author:

   258	Robbi Bishop-Taylor
     1	ClaireP

[editorialbot]

Paper file info:

🚨 Wordcount for paper.md is 2625

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

Tide Model Driver for MATLAB
Submitting author: @chadagreene
Handling editor: @kthyng (Active)
Reviewers: @adamdanz, @lnferris
Similarity score: 0.7210

pyDeltaRCM: a flexible numerical delta model
Submitting author: @amoodie
Handling editor: @kbarnhart (Retired)
Reviewers: @zsylvester, @jhnienhuis, @salterg
Similarity score: 0.6516

xeofs: Comprehensive EOF analysis in Python with xarray
Submitting author: @nicrie
Handling editor: @samhforbes (Active)
Reviewers: @DamienIrving, @malmans2
Similarity score: 0.6395

ExoTETHyS: Tools for Exoplanetary Transits around host stars
Submitting author: @gmorello
Handling editor: @arfon (Active)
Reviewers: @steven-murray, @williamjameshandley
Similarity score: 0.6350

OceanSpy: A Python package to facilitate ocean model data analysis and visualization
Submitting author: @malmans2
Handling editor: @kthyng (Active)
Reviewers: @tomchor, @platipodium
Similarity score: 0.6336

⚠️ 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.

[kthyng]

Hi @robbibt and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

• OSI-approved license
• Installation instructions
• Documentation exists at all
• Tests of some sort
• Check paper (make sure compiles, read through, check for length 250-1000 words)
• Substantial scholarly effort
• Clear research application

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

[kthyng]

Please reduce to length of your paper to up to about 1000 words. Paper format information here: https://joss.readthedocs.io/en/latest/paper.html. You can check paper length (and a few other items) with the command @editorialbot check repository though note it needs to be the first item in a comment to run correctly. Currently it has 2625 words.

[robbibt]

@editorialbot commands

[editorialbot]

Hello @robbibt, 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

[robbibt]

@editorialbot check references

[editorialbot]

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

✅ OK DOIs

- 10.5281/zenodo.5555395 is OK
- 10.5281/zenodo.3509134 is OK
- 10.25080/Majora-92bf1922-00a is OK
- 10.5334/jors.148 is OK
- 10.3390/rs4113417 is OK
- 10.1016/j.rse.2017.04.009 is OK
- 10.1002/gdj3.174 is OK
- 10.26186/145234 is OK
- 10.26186/149403 is OK
- 10.21105/joss.06683 is OK
- 10.1016/j.rse.2013.12.019 is OK
- 10.1016/j.rse.2021.112734 is OK
- 10.1016/j.ecss.2019.03.006 is OK
- 10.3390/rs10030480 is OK
- 10.1017/cft.2022.4 is OK
- 10.1016/j.coastaleng.2021.103919 is OK
- 10.1016/j.envsoft.2019.104528 is OK
- 10.2139/ssrn.4858713 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: opendatacube/odc-geo
- No DOI given, and none found for title: A new barotropic tide model for global ocean: FES2...
- No DOI given, and none found for title: SpatioTemporal Asset Catalog (STAC) specification

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[robbibt]

Thanks @kthyng, I'll work on this now.

[robbibt]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.07 s (623.9 files/s, 318028.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              2              0              0           8789
Python                          12            577           1522           2280
Jupyter Notebook                 7              0           6981           1318
Markdown                        12            354              3            676
YAML                             7             48             37            344
TeX                              1             20              0            209
TOML                             1             13              0            119
make                             1             16              8             81
CSS                              1              3              3             20
Dockerfile                       1              6              6              9
INI                              1              1              0              4
-------------------------------------------------------------------------------
SUM:                            46           1038           8560          13849
-------------------------------------------------------------------------------

Commit count by author:

   263	Robbi Bishop-Taylor
     1	ClaireP

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1584

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[robbibt]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.07 s (620.4 files/s, 316237.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              2              0              0           8789
Python                          12            577           1522           2280
Jupyter Notebook                 7              0           6981           1318
Markdown                        12            355              3            677
YAML                             7             48             37            344
TeX                              1             20              0            209
TOML                             1             13              0            119
make                             1             16              8             81
CSS                              1              3              3             20
Dockerfile                       1              6              6              9
INI                              1              1              0              4
-------------------------------------------------------------------------------
SUM:                            46           1039           8560          13850
-------------------------------------------------------------------------------

Commit count by author:

   264	Robbi Bishop-Taylor
     1	ClaireP

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1519

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[robbibt]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.07 s (615.0 files/s, 313527.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              2              0              0           8789
Python                          12            577           1522           2280
Jupyter Notebook                 7              0           6981           1318
Markdown                        12            355              3            677
YAML                             7             48             37            344
TeX                              1             20              0            209
TOML                             1             13              0            119
make                             1             16              8             81
CSS                              1              3              3             20
Dockerfile                       1              6              6              9
INI                              1              1              0              4
-------------------------------------------------------------------------------
SUM:                            46           1039           8560          13850
-------------------------------------------------------------------------------

Commit count by author:

   265	Robbi Bishop-Taylor
     1	ClaireP

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1480

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[robbibt]

Hi @kthyng, I've significantly reduced the length of the paper by approximately half: from 2625 to 1480 words. I've made sure that the "summary" and "statement of need" are within the requested limit (the remainder is a brief snapshot of the package's key features).

I've also fixed up the referencing issues highlighted above.

Here are some suggestions for reviewers with expertise in coastal Python package development:

• Kilian Vos (kvos), author CoastSat Python package
• Sharon Fitzpatrick (2320sharon), author CoastSeg Python package
• Floris Calkoen (FlorisCalkoen), author coastpy Python package
• Freya Muir (fmemuir), author vegsat Python package
• Nicholas Pucino (npucino), author sandpyper Python package

[kthyng]

@editorialbot generate pdf

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

Tide Model Driver for MATLAB
Submitting author: @chadagreene
Handling editor: @kthyng (Active)
Reviewers: @adamdanz, @lnferris
Similarity score: 0.6932

xeofs: Comprehensive EOF analysis in Python with xarray
Submitting author: @nicrie
Handling editor: @samhforbes (Active)
Reviewers: @DamienIrving, @malmans2
Similarity score: 0.6587

OceanSpy: A Python package to facilitate ocean model data analysis and visualization
Submitting author: @malmans2
Handling editor: @kthyng (Active)
Reviewers: @tomchor, @platipodium
Similarity score: 0.6471

sandpyper: A Python package for UAV-SfM beach volumetric and behavioural analysis
Submitting author: @npucino
Handling editor: @crvernon (Active)
Reviewers: @dbuscombe-usgs, @chrisleaman
Similarity score: 0.6406

pyDeltaRCM: a flexible numerical delta model
Submitting author: @amoodie
Handling editor: @kbarnhart (Retired)
Reviewers: @zsylvester, @jhnienhuis, @salterg
Similarity score: 0.6391

⚠️ 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.

[kthyng]

@robbibt I appreciate the magnitude of words you've removed, but please do get down to about 1000 words. I'd recommend moving the more detailed sections about how to use the software into documentation.

[kthyng]

@pdebuyl Could you edit this submission? It's almost ready, though the author still needs to reduce the paper length some before starting.

[kthyng]

@editorialbot invite @pdebuyl as editor

[editorialbot]

Invitation to edit this submission sent!

[robbibt]

Thanks @kthyng, and apologies for the hassle here: I was basing my submission on this previous JOSS paper which has a word count of around 3400 words, so I didn't know how strictly the word limit was applied: https://joss.theoj.org/papers/10.21105/joss.06683

I'll try and reduce it a little further. We do have more detailed content in our docs, but I was really hoping to keep at least a brief summary of the main features and some of our figures to help articulate how the different parts of the package fit together.

[kthyng]

Ah, yeah we have started to enforce the word limit now, but that's confusing for people who have submitted before. Sorry about that. If you think it's really helpful to be in there you can go up to maybe 1200 words, but it may go up during review too.

[robbibt]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.07 s (614.0 files/s, 312983.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSV                              2              0              0           8789
Python                          12            577           1522           2280
Jupyter Notebook                 7              0           6981           1318
Markdown                        12            354              3            678
YAML                             7             48             37            344
TeX                              1             20              0            209
TOML                             1             13              0            119
make                             1             16              8             81
CSS                              1              3              3             20
Dockerfile                       1              6              6              9
INI                              1              1              0              4
-------------------------------------------------------------------------------
SUM:                            46           1038           8560          13851
-------------------------------------------------------------------------------

Commit count by author:

   266	Robbi Bishop-Taylor
     1	ClaireP

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1173

✅ The paper includes a Statement of need section

[editorialbot]

License info:

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

[robbibt]

@editorialbot check references

[editorialbot]

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

✅ OK DOIs

- 10.5281/zenodo.5555395 is OK
- 10.5281/zenodo.3509134 is OK
- 10.25080/Majora-92bf1922-00a is OK
- 10.5334/jors.148 is OK
- 10.3390/rs4113417 is OK
- 10.1016/j.rse.2017.04.009 is OK
- 10.1002/gdj3.174 is OK
- 10.26186/145234 is OK
- 10.26186/149403 is OK
- 10.21105/joss.06683 is OK
- 10.1016/j.rse.2013.12.019 is OK
- 10.1016/j.rse.2021.112734 is OK
- 10.1016/j.ecss.2019.03.006 is OK
- 10.3390/rs10030480 is OK
- 10.1017/cft.2022.4 is OK
- 10.1016/j.coastaleng.2021.103919 is OK
- 10.1016/j.envsoft.2019.104528 is OK
- 10.2139/ssrn.4858713 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: opendatacube/odc-geo
- No DOI given, and none found for title: A new barotropic tide model for global ocean: FES2...
- No DOI given, and none found for title: SpatioTemporal Asset Catalog (STAC) specification

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[robbibt]

@editorialbot generate pdf

[editorialbot]

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

[robbibt]

@kthyng @pdebuyl I have now cut it down to 1173 words. Thanks for your help so far, and please let me know if I can do anything else to help prepare it for review.

[kthyng]

Thanks @robbibt! Hopefully we'll hear back from @pdebuyl soon to see about your editor.