[REVIEW]: RESOURCECODE: A Python package for statistical analysis of sea-state hindcast data

[editorialbot]

Submitting author: !--author-handle-->@NRaillard<!--end-author-handle-- (Nicolas Raillard) Repository: https://gitlab.ifremer.fr/resourcecode/resourcecode Branch with paper.md (empty if default branch): joss_paper Version: 1.0.0 Editor: !--editor-->@marcosvital<!--end-editor-- Reviewers: @krober10nd, @platipodium, @malmans2 Archive: 10.5281/zenodo.7681494

Status

Status badge code:

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

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@krober10nd & @platipodium & @malmans2, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @marcosvital know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @platipodium

📝 Checklist for @malmans2

📝 Checklist for @krober10nd

[NRaillard]

@editorialbot generate pdf

We have released a new version (0.6.0) to solve the installation problem on python 3.10. Along with this new version, we added the functionality to download 1D and 2D spectral data and to compute sea-state parameters from this data. This version is already on pypi The paper is amended to present this new functions, and a new notebook is available on the web portal

[editorialbot]

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

[marcosvital]

Hi, @krober10nd! Have you had the chance to check @NRaillard responses?

I think that it would be specially important to see if you feel that the use-cases presented on the website might be enough and if the installation issues are solved.

[marcosvital]

@NRaillard, I wonder if some of the use-cases could also be presented on the documentation. Would that make sense?

[NRaillard]

Some of the use-cases can be quite long to generate as it gets data from the remote server but I think that some examples can be extracted from the notebook to integrate them into the documentation. I have to look more precisely about the way I can automate it with sphinx...

[NRaillard]

Following @marcosvital suggestion, I used sphinx-gallery to generate examples within the documentation. I agree that it is far more clear for the user. The updated documentation is already online. Let me know if it answers your concerns.

[NRaillard]

Some bugs found by the users have been corrected, see version 0.6.2 and changelog . Let me know if it answers your concerns.

[NRaillard]

Hello @marcosvital, do you have any update about the issues that may be missing ? If ever our proposal does not fit into JOSS, please just let me know.

[arfon]

:wave: @marcosvital – just checking in here on what the next steps are for this submission?

[marcosvital]

Hello @marcosvital, do you have any update about the issues that may be missing ? If ever our proposal does not fit into JOSS, please just let me know.

Hi, @NRaillard, sorry about the late response. Let's try to advance and reach a final decision as fast as possible.

[marcosvital]

Hello again, @krober10nd! Have you had the chance to check @NRaillard responses and updates?

Do youI feel that the use-cases presented on the website might be enough and if the installation issues are solved?

[krober10nd]

@marcosvital Yes, I have reviewed the updated documentation and the new examples and layout look great. I feel those issues are now resolved.

I approve this submission.

[marcosvital]

@marcosvital Yes, I have reviewed the updated documentation and the new examples and layout look great. I feel those issues are now resolved.

I approve this submission.

Thank you for this update and for all the effort put into this review, @krober10nd.

[marcosvital]

@NRaillard it seems we are almost done here. I'll generate a new version of the manuscript, so please take a careful look at it to see if you need any last corrections or modifications, ok?

[marcosvital]

@editorialbot generate pdf

[editorialbot]

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

[marcosvital]

@editorialbot check references

[editorialbot]

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

OK DOIs

- 10.1016/j.oceaneng.2019.05.016 is OK
- 10.1016/j.oceaneng.2013.04.015 is OK
- 10.25080/Majora-92bf1922-00a is OK

MISSING DOIs

- None

INVALID DOIs

- None

[marcosvital]

@NRaillard after reviewing the final version, you will need to archive the last release of the package (on Zenodo, figshare, or other) - if you already didn't do this, please let me know the package version number (or if ti still on 0.5.5) and archive DOI.

[NRaillard]

Hi @marcosvital , thanks for your messages, i'm just back from vacations and I will do it ASAP. I would like to switch to version 1.0 with the release of the paper, maybe I should wait for having the DOI to include it in the changelog and pushing v1.0 to pypi ? Or maybe I am doing it wrong ?

[NRaillard]

@editorialbot generate pdf

[editorialbot]

:warning: An error happened when generating the pdf.

[NRaillard]

@editorialbot generate pdf

[editorialbot]

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

[NRaillard]

Hello @marcosvital , I have uploaded the source code to Zenodo here . Please, let me know if there is something else I should do.

[NRaillard]

Hi @marcosvital, it seems that I have forgotten the version number... Version 1.0.0 is released on pypi and is the reference version. Thanks !

[marcosvital]

@editorialbot set 1.0.0 as version

[editorialbot]

Done! version is now 1.0.0

[marcosvital]

@editorialbot set 10.5281/zenodo.7681494 as archive

[editorialbot]

Done! Archive is now 10.5281/zenodo.7681494

[marcosvital]

@editorialbot generate pdf

[editorialbot]

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

[marcosvital]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

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

OK DOIs

- 10.1016/j.oceaneng.2019.05.016 is OK
- 10.1016/j.oceaneng.2013.04.015 is OK
- 10.25080/Majora-92bf1922-00a is OK

MISSING DOIs

- None

INVALID DOIs

- None

[editorialbot]

:wave: @openjournals/ese-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/4070, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[kthyng]

Hi! I have some final checks to do before final acceptance.

• [x] Check that version was updated
• [x] Check that software archive exists, has been input to JOSS, and title and author list look good
• [x] Check paper

[kthyng]

Ok everything looks good! I will run final acceptance.

[kthyng]

@editorialbot accept

[editorialbot]

Doing it live! Attempting automated processing of paper acceptance...

[editorialbot]

:warning: Couldn't acccept/publish paper. An error happened.

[kthyng]

@editorialbot accept

[editorialbot]

Doing it live! Attempting automated processing of paper acceptance...

[editorialbot]

:warning: Couldn't acccept/publish paper. An error happened.

[kthyng]

@openjournals/dev I took a look at the errors and I don't see an obvious issue with the paper. Is something else going on?

[xuanxu]

There's been an error in a post acceptance task, but the paper has been correctly accepted an deposited. The DOI is 10.21105/joss.04366

[kthyng]

@xuanxu Ok, is there something I can do to wrap up this review issue or should I wait and try again later?

[xuanxu]

I've added the accepted label so closing the issue will wrap it up.

[kthyng]

Ok great, thanks!

It's a little anti-climactic without the text that usually comes up upon acceptance, but congrats on your new publication @NRaillard! Many thanks to editor @marcosvital and reviewers @krober10nd, @platipodium, and @malmans2 for your time, hard work, and expertise!!

[editorialbot]

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.04366/status.svg)](https://doi.org/10.21105/joss.04366)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04366">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04366/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04366/status.svg
   :target: https://doi.org/10.21105/joss.04366

This is how it will look in your documentation:

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://reviewers.joss.theoj.org/join
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss