openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
696 stars 36 forks source link

[PRE REVIEW]: EddyProfSync: A MATLAB tools for collocating coherent eddy and hydrographic datasets #6211

Closed editorialbot closed 6 months ago

editorialbot commented 6 months ago

Submitting author: !--author-handle-->@rampatels<!--end-author-handle-- (Ramkrushnbhai Shaileshbhai Patel) Repository: https://github.com/rampatels/EddyProfileCollocator Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: Kristen Thyng

Status

status

Status badge code:

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

Author instructions

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

@rampatels 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 commented 6 months ago

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 commented 6 months ago
Software report:

github.com/AlDanial/cloc v 1.88  T=0.19 s (89.7 files/s, 330550.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                             2           3398              4          42333
Jupyter Notebook                 2              0          15865            327
MATLAB                           9             64            209            197
TeX                              1             12              0            107
Markdown                         2             30              0             92
JSON                             1              0              0              3
-------------------------------------------------------------------------------
SUM:                            17           3504          16078          43059
-------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository
editorialbot commented 6 months ago

Wordcount for paper.md is 483

editorialbot commented 6 months ago

Failed to discover a valid open source license

editorialbot commented 6 months ago

Failed to discover a Statement of need section in paper

editorialbot commented 6 months ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.1016/j.pocean.2011.01.002 may be a valid DOI for title: Global observations of nonlinear mesoscale eddies
- 10.1038/sdata.2015.28 may be a valid DOI for title: A daily global mesoscale ocean eddy dataset from satellite altimetry
- 10.1002/2015jc010950 may be a valid DOI for title: Main eddy vertical structures observed in the four major Eastern Boundary Upwelling Systems
- 10.1029/2011jc007134 may be a valid DOI for title: Vertical structure of mesoscale eddies in the eastern South Pacific Ocean: A composite analysis from altimetry and Argo profiling floats
- 10.1029/2022jc018679 may be a valid DOI for title: Stacking of EAC eddies observed from Argo
- 10.1029/2018jc014655 may be a valid DOI for title: Meridional Heat and Salt Transport Across the Subantarctic Front by Cold-Core Eddies
- 10.1002/2015gl066050 may be a valid DOI for title: Recent freshening of the East Australian Current and its eddies
- 10.1175/jtech-d-14-00019.1 may be a valid DOI for title: A new sea surface height–based code for oceanic mesoscale eddy tracking
- 10.5194/essd-14-1087-2022 may be a valid DOI for title: META3. 1exp: a new global mesoscale eddy trajectory atlas derived from altimetry

INVALID DOIs

- None
editorialbot commented 6 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

editorialbot commented 6 months ago

Five most similar historical JOSS papers:

ocean_data_tools: A MATLAB toolbox for interacting with bulk freely-available oceanographic data Submitting author: @lnferris Handling editor: @kthyng (Active) Reviewers: @kakearney, @castelao Similarity score: 0.8288

BioSigKit: A Matlab Toolbox and Interface for Analysis of BioSignals Submitting author: @hooman650 Handling editor: @Kevin-Mattheus-Moerman (Active) Reviewers: @marianux, @fernandoandreotti, @bzenger Similarity score: 0.8180

eddy: Extracting Protoplanetary Disk Dynamics with Python Submitting author: @richteague Handling editor: @arfon (Active) Reviewers: @kevin-flaherty Similarity score: 0.8111

Hytool: an open source matlab toolbox for the interpretation of hydraulic tests using analytical solutions Submitting author: @philipperenard Handling editor: @kyleniemeyer (Active) Reviewers: @pboesu Similarity score: 0.8061

uDALES: large-eddy-simulation software for urban flow, dispersion, and microclimate modelling Submitting author: @tomgrylls Handling editor: @Kevin-Mattheus-Moerman (Active) Reviewers: @wimvanderbauwhede, @p-costa, @ashwinvis Similarity score: 0.8058

⚠️ 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 commented 6 months ago

@rampatels Thanks for your submission. It looks from the summary of lines of code above that the code making up the package — MATLAB with 197 lines of code — is smaller than our amount such that I should desk reject this submission (https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort). Am I missing some more code associated with this submission?

kthyng commented 6 months ago

@rampatels I would have preferred to hear back from you first but I'll go ahead and reject this based on having too few lines of code since there are fewer than 300 lines of code (https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort).

kthyng commented 6 months ago

@editorialbot reject

editorialbot commented 6 months ago

Paper rejected.

rampatels commented 6 months ago

@rampatels Thanks for your submission. It looks from the summary of lines of code above that the code making up the package — MATLAB with 197 lines of code — is smaller than our amount such that I should desk reject this submission (https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort). Am I missing some more code associated with this submission?

I apologise for being on my annual leave after the submission of EddyProfSync and did not expect this fast turn around. I humbly request you to reconsider this work. The original code was more than 1000 LOC, but my beta user colleague ran it on Southern Ocean scale data and found that it was taking an enormously long time. So, I had to optimise. To this end, I divided EddyProfSync into several chunks, which reduced the size of src files and fast. This is achieved by removing redundant for loops and other recursive stuff via introduction of subfunctions. Then, I omitted the preprocessing step and provided them in the \utils directory, as my original intent to simply focus on Argo data and META eddies. But to make it even more generalise and include CTD profiles, as it is a focus of my current research. This even further divides the original code and allow user to apply this software to their choice of instrument in preprocessing through tutorials and make actual code independent of data source. That is why the \src files are too short as per the JOSS guidelines but other part of the scripts are in \utils directory which accounts for four most common sources of data used for mesoscale eddy research. Furthermore, I have written tutorials in .ipynb for better documentation, which uses MATLAB kernel. So the tutorial code is in .ipynb.
Thank you for the opportunity. Ram