Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REVIEW]: xeofs: Comprehensive EOF analysis in Python with xarray #6060

Closed
editorialbot opened this issue Nov 15, 2023 · 50 comments
Closed

[REVIEW]: xeofs: Comprehensive EOF analysis in Python with xarray #6060

editorialbot opened this issue Nov 15, 2023 · 50 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 6 (ESE) Earth Sciences and Ecology

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Nov 15, 2023

Submitting author: @nicrie (Niclas Rieger)
Repository: https://github.com/nicrie/xeofs
Branch with paper.md (empty if default branch): joss-submission
Version: v2.2.4
Editor: @samhforbes
Reviewers: @DamienIrving, @malmans2
Archive: 10.5281/zenodo.10428233

Status

status

Status badge code:

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

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

@DamienIrving & @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 @samhforbes 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 @DamienIrving

📝 Checklist for @malmans2

@editorialbot
Copy link
Collaborator Author

Hello humans, 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
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.24 s (743.3 files/s, 164147.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          92           2861           4129          10126
HTML                             1           1244              2           6337
Markdown                         6            571              0            738
reStructuredText                52           2817           5787            641
TeX                              1             40              0            398
YAML                             8             36             29            162
Jupyter Notebook                15              0           3347            109
TOML                             1              7              0             55
CSS                              1              6              1             29
DOS Batch                        1              8              1             26
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                           179           7594          13303          18630
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 805

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.5334/jors.122 is OK
- 10.5334/jors.148 is OK
- 10.1007/978-3-642-86940-2_10 is OK
- 10.1002/joc.1499 is OK
- 10.1175/JCLI-D-20-0266.1 is OK
- 10.1109/TGRS.2020.2969813 is OK
- 10.1007/978-3-030-67073-3 is OK
- 10.2307/2333955 is OK
- 10.1016/0304-4076(76)90010-5 is OK
- 10.1175/1520-0442(1992)005<0541:AIOMFF>2.0.CO;2 is OK
- 10.1175/1520-0442(1995)008<2631:OROSPD>2.0.CO;2 is OK
- 10.1175/JCLI-D-16-0664.1 is OK
- 10.1175/JCLI-D-21-0244.1 is OK
- 10.1080/13658816.2011.554838 is OK
- 10.1016/0167-2789(86)90031-X is OK
- 10.1175/1520-0493(1982)110<0481:EOEEOF>2.0.CO;2 is OK
- 10.1175/1520-0450(1984)023<1660:CPCATA>2.0.CO;2 is OK
- 10.1175/1520-0493(1981)109<0587:BVISTO>2.0.CO;2 is OK
- 10.1175/1520-0493(1983)111<0756:IOTMAP>2.0.CO;2 is OK
- 10.1175/JCLI3879.1 is OK
- 10.1175/1520-0469(2001)058<1341:OPPITV>2.0.CO;2 is OK
- 10.1007/BF02289233 is OK
- 10.1111/j.2044-8317.1964.tb00244.x is OK
- 10.1137/090771806 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@samhforbes
Copy link

@DamienIrving, @malmans2 this is our review thread - we track main issues and your checklist in here, following the instructions above. Any issues you encounter or changes to make during your review you can raise as issues in the software repository directly, and feel free to link back here.

@DamienIrving
Copy link

DamienIrving commented Nov 17, 2023

Review checklist for @DamienIrving

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/nicrie/xeofs?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@nicrie) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@kthyng
Copy link

kthyng commented Dec 13, 2023

Hi @DamienIrving, @malmans2! How are your reviews coming along?

@DamienIrving
Copy link

I'm all done - sorry for the delay!

The authors have done a really excellent job with the package and associated documentation.

The only very minor issue I found was a broken link to the contributing guide, for which I've submitted a pull request to fix: xarray-contrib/xeofs#129

@samhforbes
Copy link

That's great, thanks @DamienIrving

@malmans2
Copy link

malmans2 commented Dec 14, 2023

Review checklist for @malmans2

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/nicrie/xeofs?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@nicrie) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@malmans2
Copy link

Hi all, sorry about the delay!

I glanced through the repository and xeofs looks in great shape.
I'll go through all the formal steps by the end of the week and will let you know when I'm done.

@malmans2
Copy link

malmans2 commented Dec 15, 2023

Hi everyone! I'm done with my review.

Great package, and it's 100% in line with JOSS standards.
If I'll need to perform EOFs, I will definitely use it.

I opened 2 minor issues:

I suggest to open a PR in xarray and add xeofs here: https://docs.xarray.dev/en/stable/ecosystem.html

nicrie added a commit to nicrie/xarray that referenced this issue Dec 19, 2023
Suggestion to include [xeofs](https://github.com/nicrie/xeofs) in the xarray ecosystem documentation.

xeofs enables fully multidimensional PCA / EOF analysis and related techniques with large datasets, thanks to the integration of xarray and dask.

References:
- [Github repository](https://github.com/nicrie/xeofs)
- [Documentation](https://xeofs.readthedocs.io/en/latest/)
- [JOSS review](openjournals/joss-reviews#6060)
@nicrie
Copy link

nicrie commented Dec 19, 2023

Hi, many thanks @DamienIrving and @malmans2 for the reviews and the suggestions for improvement. We have incorporated the feedback and opened a PR for the xarray documentation here.

dcherian pushed a commit to pydata/xarray that referenced this issue Dec 19, 2023
Suggestion to include [xeofs](https://github.com/nicrie/xeofs) in the xarray ecosystem documentation.

xeofs enables fully multidimensional PCA / EOF analysis and related techniques with large datasets, thanks to the integration of xarray and dask.

References:
- [Github repository](https://github.com/nicrie/xeofs)
- [Documentation](https://xeofs.readthedocs.io/en/latest/)
- [JOSS review](openjournals/joss-reviews#6060)
@samhforbes
Copy link

Hi @DamienIrving and @malmans2 I can see you've ticked everything off. Can you confirm you are happy with the changes made and there are no outstanding concerns please?
Thanks for answering the issues so comprehensively @nicrie - I've also tried this out and it works nicely!

@nicrie
Copy link

nicrie commented Jan 2, 2024

Done @samhforbes, thank you !

@samhforbes
Copy link

@editorialbot set 10.5281/zenodo.10428233 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.10428233

@samhforbes
Copy link

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.5334/jors.122 is OK
- 10.5334/jors.148 is OK
- 10.1007/978-3-642-86940-2_10 is OK
- 10.1002/joc.1499 is OK
- 10.1175/JCLI-D-20-0266.1 is OK
- 10.1109/TGRS.2020.2969813 is OK
- 10.1007/978-3-030-67073-3 is OK
- 10.2307/2333955 is OK
- 10.1016/0304-4076(76)90010-5 is OK
- 10.1175/1520-0442(1992)005<0541:AIOMFF>2.0.CO;2 is OK
- 10.1175/1520-0442(1995)008<2631:OROSPD>2.0.CO;2 is OK
- 10.1175/JCLI-D-16-0664.1 is OK
- 10.1175/JCLI-D-21-0244.1 is OK
- 10.1080/13658816.2011.554838 is OK
- 10.1016/0167-2789(86)90031-X is OK
- 10.1175/1520-0493(1982)110<0481:EOEEOF>2.0.CO;2 is OK
- 10.1175/1520-0450(1984)023<1660:CPCATA>2.0.CO;2 is OK
- 10.1175/1520-0493(1981)109<0587:BVISTO>2.0.CO;2 is OK
- 10.1175/1520-0493(1983)111<0756:IOTMAP>2.0.CO;2 is OK
- 10.1175/JCLI3879.1 is OK
- 10.1175/1520-0469(2001)058<1341:OPPITV>2.0.CO;2 is OK
- 10.1007/BF02289233 is OK
- 10.1111/j.2044-8317.1964.tb00244.x is OK
- 10.1137/090771806 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@samhforbes
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@samhforbes
Copy link

Great! @nicrie thanks for the great work you have done on this package - I am happy to recommend acceptance and pass it over to the EiCs.
Thanks @DamienIrving, @malmans2 for your great reviews.

@samhforbes
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.5334/jors.122 is OK
- 10.5334/jors.148 is OK
- 10.1007/978-3-642-86940-2_10 is OK
- 10.1002/joc.1499 is OK
- 10.1175/JCLI-D-20-0266.1 is OK
- 10.1109/TGRS.2020.2969813 is OK
- 10.1007/978-3-030-67073-3 is OK
- 10.2307/2333955 is OK
- 10.1016/0304-4076(76)90010-5 is OK
- 10.1175/1520-0442(1992)005<0541:AIOMFF>2.0.CO;2 is OK
- 10.1175/1520-0442(1995)008<2631:OROSPD>2.0.CO;2 is OK
- 10.1175/JCLI-D-16-0664.1 is OK
- 10.1175/JCLI-D-21-0244.1 is OK
- 10.1080/13658816.2011.554838 is OK
- 10.1016/0167-2789(86)90031-X is OK
- 10.1175/1520-0493(1982)110<0481:EOEEOF>2.0.CO;2 is OK
- 10.1175/1520-0450(1984)023<1660:CPCATA>2.0.CO;2 is OK
- 10.1175/1520-0493(1981)109<0587:BVISTO>2.0.CO;2 is OK
- 10.1175/1520-0493(1983)111<0756:IOTMAP>2.0.CO;2 is OK
- 10.1175/JCLI3879.1 is OK
- 10.1175/1520-0469(2001)058<1341:OPPITV>2.0.CO;2 is OK
- 10.1007/BF02289233 is OK
- 10.1111/j.2044-8317.1964.tb00244.x is OK
- 10.1137/090771806 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4868, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Jan 2, 2024
@kthyng
Copy link

kthyng commented Jan 2, 2024

My steps:

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

@kthyng
Copy link

kthyng commented Jan 2, 2024

Paper comments:

@nicrie
Copy link

nicrie commented Jan 2, 2024

Thank you for the comments @kthyng, both points should be addressed now by the recent commits.

@kthyng
Copy link

kthyng commented Jan 2, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@kthyng
Copy link

kthyng commented Jan 2, 2024

Ok ready to go!

@kthyng
Copy link

kthyng commented Jan 2, 2024

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: Rieger
  given-names: Niclas
  orcid: "https://orcid.org/0000-0003-3357-1742"
- family-names: Levang
  given-names: Samuel J.
doi: 10.5281/zenodo.10428233
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Rieger
    given-names: Niclas
    orcid: "https://orcid.org/0000-0003-3357-1742"
  - family-names: Levang
    given-names: Samuel J.
  date-published: 2024-01-02
  doi: 10.21105/joss.06060
  issn: 2475-9066
  issue: 93
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6060
  title: "xeofs: Comprehensive EOF analysis in Python with xarray"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06060"
  volume: 9
title: "xeofs: Comprehensive EOF analysis in Python with xarray"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.06060 joss-papers#4869
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06060
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Jan 2, 2024
@kthyng
Copy link

kthyng commented Jan 2, 2024

Congrats on your new publication to @nicrie! Many thanks to editor @samhforbes and reviewers @DamienIrving, and @malmans2 for your time, hard work, and expertise!!

@kthyng kthyng closed this as completed Jan 2, 2024
@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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.06060/status.svg)](https://doi.org/10.21105/joss.06060)

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

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

This is how it will look in your documentation:

DOI

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:

@nicrie
Copy link

nicrie commented Jan 2, 2024

Wonderful! Also from our side many thanks for reviewing and editing the publication! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 6 (ESE) Earth Sciences and Ecology
Projects
None yet
Development

No branches or pull requests

6 participants