[REVIEW]: CLIMLAB: a Python toolkit for interactive, process-oriented climate modeling

[whedon]

Submitting author: @brian-rose (Brian Rose)
Repository: https://github.com/brian-rose/climlab/
Version: v0.6.4
Editor: @lheagy
Reviewer: @Chilipp, @dhhagan
Archive: 10.5281/zenodo.1226360

Status

Status badge code:

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

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) 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

@Chilipp & @dhhagan, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

1. Make sure you're logged in to your GitHub account
2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @lheagy know.

Review checklist for @Chilipp

Conflict of interest

• As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Version: Does the release version given match the GitHub release (v0.6.4)?
• Authorship: Has the submitting author (@brian-rose) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

• Authors: Does the paper.md file include a list of authors with their affiliations?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @dhhagan

Conflict of interest

• As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Version: Does the release version given match the GitHub release (v0.6.4)?
• Authorship: Has the submitting author (@brian-rose) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

• Authors: Does the paper.md file include a list of authors with their affiliations?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

[whedon]

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @Chilipp, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

For a list of things I can do to help you, just type:

@whedon commands

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

--> Check article proof 📄 <--

[lheagy]

Thanks @Chilipp and @dhhagan for being willing to review. The review issue is here, and there is a checklist above for each of you as you review the software. Please don't hesitate to reach out with questions!

[lheagy]

👋 Thanks @Chilipp and @dhhagan for being willing to review. There is a checklist above for each of you as you go through the review process. It works through general checks, installation, functionality and the quality of the paper. Please let me know if you have any questions or if I can be of assistance in the review process!

[Chilipp]

@lheagy and @brian-rose: I apologize for the delay that is caused by the EGU. I expect to have it done at latest by Tuesday evening.

[Chilipp]

Done so far.

• There are some minor issues mentioned in PR https://github.com/brian-rose/climlab/pull/67 which can be solved by merging the PR
• @brian-rose: Please add community guidelines (see above) with
  1. How to contribute to the software
  2. How to report issues or problems with the software
  3. How to seek support

@lheagy: If those 2 points are solved, the paper should be accepted

[brian-rose]

Thanks @Chilipp for the help with the references and the Python 3 update. I merged the PR.

Will add some community guidelines next.

[lheagy]

Thanks @Chilipp and @brian-rose!

[brian-rose]

The documentation now includes a new page (http://climlab.readthedocs.io/en/latest/contributing.html) with explicit guidelines for

• reporting bugs and issues
• seeking help and support
• contributing bug fixes, new features, and documentation

There is also a new open github issue where I'm inviting people to self-report their usage of CLIMLAB. I hope to collect references and links and make these available as additional resources for new users.

[Chilipp]

Thanks @brian-rose! That is fine with me. However, apparently you wrote the CONTRIBUTING in markdown, which doesn't render well in your docs. I'd recommend to fix this.

[brian-rose]

@Chilipp thanks for finding that. I fixed up the formatting of the new page and got rid of the errant bit of markdown.

[dhhagan]

Hey @brian-rose I suggested adding more clear instructions on running the tests, otherwise this paper is good to go!

[lheagy]

Thanks @dhhagan and @Chilipp for a speedy and thorough review! @brian-rose: please keep us updated on your progress on brian-rose/climlab#69 - we can proceed with publishing once addressed

[brian-rose]

As noted in https://github.com/brian-rose/climlab/issues/69, there is now a new section in the docs on Building and Testing CLIMLAB with explicit instructions.

[lheagy]

Thanks @brian-rose, @dhhagan, would you mind taking one last look and closing brian-rose/climlab#69 if it has been addressed?

[dhhagan]

Should be good-to-go!

[lheagy]

@arfon, this submission is ready to be published. Congratulations @brian-rose!

Many thanks @Chilipp and @dhhagan for your work on this review!

[brian-rose]

Thanks all.

[arfon]

@brian-rose - At this point could you make an archive of the reviewed software in Zenodo/figshare/other service and update this thread with the DOI of the archive? I can then move forward with accepting the submission.

[brian-rose]

I just released climlab v0.6.5 including the updated documentation. It is archived on Zenodo under doi:10.5281/zenodo.1226360 (direct link)

[arfon]

@whedon set 10.5281/zenodo.1226360 as archive

[whedon]

OK. 10.5281/zenodo.1226360 is the archive.

[arfon]

@Chilipp, @dhhagan - many thanks for your reviews here and to @lheagy for editing this submission ✨

@brian-rose - your paper is now accepted into JOSS and your DOI is https://doi.org/10.21105/joss.00659 ⚡ 🚀 💥

[whedon]

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

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

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

This is how it will look in your documentation:

We need your help!

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: http://joss.theoj.org/reviewer-signup.html
• Making a small donation to support our running costs here: https://www.flipcause.com/secure/cause_pdetails/Mjk3Nzk=

[brian-rose]

Great news, thanks @arfon.