Skip to content

Solar Data Tools Submission #210

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

Open
21 of 32 tasks
pluflou opened this issue Aug 17, 2024 · 57 comments
Open
21 of 32 tasks

Solar Data Tools Submission #210

pluflou opened this issue Aug 17, 2024 · 57 comments
Assignees

Comments

@pluflou
Copy link

pluflou commented Aug 17, 2024

Submitting Author: Sara Miskovich (@pluflou)
All current maintainers: (@pluflou, @bmeyers)
Package Name: Solar Data Tools
One-Line Description of Package: Library of tools for analyzing photovoltaic power time-series data.
Repository Link: https://github.com/slacgismo/solar-data-tools
Version submitted: 1.6.4
EiC: @cmarmo
Editor: @shirubana
Reviewer 1: @jinningwang
Reviewer 2: @echedey-ls
Reviewer 3: @cdeline
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): 06/13/2025


Code of Conduct & Commitment to Maintain Package

Description

  • Include a brief paragraph describing what your package does:
    Solar Data Tools is an open-source Python library for analyzing PV power (and irradiance) time-series data. It provides methods for data I/O, cleaning, filtering, plotting, and analysis. These methods are largely automated and require little to no input from the user regardless of system type—from utility tracking systems to multi-pitch rooftop systems. Solar Data Tools was developed to enable analysis of unlabeled PV data, i.e. with no model, no meteorological data, and no performance index required, by taking a statistical signal processing approach in the algorithms used in the package’s main data processing pipeline.

Scope

  • Please indicate which category or categories.
    Check out our package scope page to learn more about our
    scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

    • Data retrieval
    • Data extraction
    • Data processing/munging
    • Data deposition
    • Data validation and testing
    • Data visualization1
    • Workflow automation
    • Citation management and bibliometrics
    • Scientific software wrappers
    • Database interoperability

Domain Specific

  • Geospatial
  • Education

Community Partnerships

If your package is associated with an
existing community please check below:

  • For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

    • Who is the target audience and what are scientific applications of this package?
      This package is for anyone dealing with photovoltaic data, especially data with no meteorological information (unlabeled). This includes photovoltaic professionals (in private solar industry or utility companies for example), researchers and students in the solar power domain, community solar owners, and anyone with a rooftop system. The scientific goal of the package is to facilitate analysis of photovoltaic data for any system, even those that are difficult to model, and the package uses signal decomposition to achieve that.

    • Are there other Python packages that accomplish the same thing? If so, how does yours differ?
      There are two other packages that are similar in that they offer data analysis tools for solar applications: PVAnalytics and RdTools. They are both model driven, and require the user to define their own analysis. PVAnalytics focuses on preprocessing and QA, while RdTools focuses on loss factor analysis. Solar Data Tools provides both data quality and loss factor analysis, runs automatically with little to no setup, and is model-free and does not require any weather or other information. Solar Data Tools is most suited for when users want a pre-defined pipeline to get information on complex systems/sites that can't be modeled easily and that no meteorological data. A recent tutorial that was part of a virtual tutorial series on open-source tools and open-access solar data held by DOE’s Solar Technology Office in March 2024 goes over the differences in these packages and when each tool is appropriate to use. You can find the recording here and the slide deck here (see slide 16 for a summary).

    • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:
      Solar Data Tools pre-submission inquiry #204 (@cmarmo)

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

  • does not violate the Terms of Service of any service it interacts with.
  • uses an OSI approved license.
  • contains a README with instructions for installing the development version.
  • includes documentation with examples for all functions.
  • contains a tutorial with examples of its essential functions and uses.
  • has a test suite.
  • has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

JOSS Checks
  • The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
  • The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
  • The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/. (will add soon)
  • The package is deposited in a long-term repository with the DOI:

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

  • Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

  • I have read the author guide.
  • I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

  1. Please fill out a pre-submission inquiry before submitting a data visualization package.

@cmarmo
Copy link
Member

cmarmo commented Aug 24, 2024

Editor in Chief checks

Hi @pluflou ! Thank you for submitting your package for pyOpenSci review.
Below are the basic checks that your package needs to pass to begin our review.
If some of these are missing, we will ask you to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements below.

  • Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
    • The package imports properly into a standard Python environment import package.
  • Fit The package meets criteria for fit and overlap.
  • Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
    • User-facing documentation that overviews how to install and start using the package.
    • Short tutorials that help a user understand how to use the package and what it can do for them.
    • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
  • Core GitHub repository Files
    • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
    • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
    • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
    • License The package has an OSI approved license.
      NOTE: We prefer that you have development instructions in your documentation too.
  • Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
  • Automated tests Package has a testing suite and is tested via a Continuous Integration service.
  • Repository The repository link resolves correctly.
  • Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
  • Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
  • Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

  • Initial onboarding survey was filled out
    We appreciate each maintainer of the package filling out this survey individually. 🙌
    Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌


Editor comments

Solar Data Tools is in excellent condition! Congratulation for all your work! 🚀

My only comment is related to the test coverage, which could be improved.
We don't set a minimal threshold for test coverage in order to start the review process, so, if you don't mind, just keep my comment somewhere as a reminder for future developments, and I'm going to look right away for an editor.

@cmarmo
Copy link
Member

cmarmo commented Aug 24, 2024

I saw a new 1.6.2 version was released while waiting for my feedback: I took the liberty to update the version submitted so the reviewers would deal with the latest version available.

@lwasser lwasser moved this from pre-review-checks to seeking-editor in peer-review-status Aug 24, 2024
@pluflou
Copy link
Author

pluflou commented Aug 24, 2024

I saw a new 1.6.2 version was released while waiting for my feedback: I took the liberty to update the version submitted so the reviewers would deal with the latest version available.

Thank you!!

@cmarmo
Copy link
Member

cmarmo commented Aug 31, 2024

Hi @pluflou , I am glad to announce that we have an editor for Solar Data Tools review.

@shirubana kindly accepted to take care of your submission. I am letting her introduce herself here and wishing a nice review process to all people involved.

@lwasser lwasser moved this from seeking-editor to under-review in peer-review-status Aug 31, 2024
@pluflou
Copy link
Author

pluflou commented Sep 14, 2024

Thank you @shirubana for volunteering to review our package! We are excited to work with you on this. In the meantime, please let us know if you have any questions!

@shirubana
Copy link

Hi, starting on this and navigating the various resources to do this properly.

@shirubana
Copy link

Ok, I think I am acquainted now with the steps/my job after perusing the guide and slack. I have started to look for reviewers.

@bmeyers
Copy link

bmeyers commented Sep 16, 2024

Thank you @shirubana! Looking forward to working with you on this.

@cmarmo cmarmo assigned shirubana and unassigned cmarmo Sep 29, 2024
@bmeyers
Copy link

bmeyers commented Oct 16, 2024

Hi @shirubana! I just wanted to check in and see if there were any updates, and if there was anything you needed from us. Thank you!

@pluflou
Copy link
Author

pluflou commented Nov 13, 2024

@cmarmo @shirubana is it possible to update to the latest version (1.6.4)? This version is now available on conda-forge (previous versions were on a private channel).

@cmarmo
Copy link
Member

cmarmo commented Nov 15, 2024

@pluflou , since the review has not started yet, I have updated the information about the submitted version in the description.

@shirubana, please let us know if you need any help to find reviewers.... unfortunately, onboarding reviewers can be tricky....

@pluflou
Copy link
Author

pluflou commented Jan 21, 2025

Hi @cmarmo @shirubana, happy new year! Just wanted to check in on how things are going, and have a small update. We have the JOSS paper in a branch's (joss_paper) root dir under paper/ and I'm just wondering if we should merge that into main or if we should provide the link to the branch. Thank you!

@lwasser
Copy link
Member

lwasser commented Jan 28, 2025

Hi Team 👋🏻 it would be great to move this review forward. I am happy to post on social to try to help find reviewers if someone can help me understand what we need here! ✨ I know it's a challenging time here in the US for science so it's super understandable that things might move more slowly because of that!

@jinningwang
Copy link

Sorry for the late reply. I finished my defense earlier this month, and should be able to give my comments in two or three days.

@bmeyers
Copy link

bmeyers commented May 1, 2025

@jinningwang congrats on the defense!

@jinningwang
Copy link

jinningwang commented May 1, 2025

Thanks for the efforts in this work! My review report is here.

Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

  • A statement of need clearly stating problems the software is designed to solve and its target audience in README.
  • Installation instructions: for the development version of the package and any non-standard dependencies in README.
  • Vignette(s) demonstrating major functionality that runs successfully locally.
  • Function Documentation: for all user-facing functions.
  • Examples for all user-facing functions.
  • Community guidelines including contribution guidelines in the README or CONTRIBUTING.
  • Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

Readme file** **requirements

The package meets the readme requirements below:

  • Package has a README.md file in the root directory.

The README should include, from top to bottom:

  • The package name
  • Badges for:

** **- [x] Continuous integration and test coverage,

** **- [x] Docs building (if you have a documentation website),

** **- [x] A repostatus.org badge,

** **- [x] Python versions supported,

** **- [x] Current package version (on PyPI / Conda).

NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)

  • Short description of package goals.
  • Package installation instructions
  • Any additional setup required to use the package (authentication tokens, etc.)
  • Descriptive links to all vignettes. If the package is small, there may only be a need for one vignette which could be placed in the README.md file.

** **- [x] Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)

  • Link to your documentation website.
  • If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
  • Citation information

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.

Package structure should follow general community best-practices. In general please consider whether:

  • Package documentation is clear and easy to find and use.
  • The need for the package is clear
  • All functions have documentation and associated examples for use
  • The package is easy to install

Functionality

  • Installation: Installation succeeds as documented.
  • Functionality: Any functional claims of the software been confirmed.
  • Performance: Any performance claims of the software been confirmed.
  • Automated tests:

** **- [x] All tests pass on the reviewer's local machine for the package version submitted by the author. Ideally this should be a tagged version making it easy for reviewers to install.

** **- [x] Tests cover essential functions of the package and a reasonable range of inputs and conditions.

  • Continuous Integration: Has continuous integration setup (We suggest using Github actions but any CI platform is acceptable for review)
  • Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.

** **A few notable highlights to look at:

** **- [x] Package supports modern versions of Python and not End of life versions.

** **- [ ] Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)

For packages also submitting to JOSS

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

  • A short summary describing the high-level functionality of the software
  • Authors: A list of authors with their affiliations
  • A statement of need clearly stating problems the software is designed to solve and its target audience.
  • References: With DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

  • The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing:
2.5

Review Comments

The package is well structured and easy to use.
The documentation is clear and provides good examples of how to use the package.
The installation process is straightforward and works as documented.
Some concerns are listed as below:

  1. A list of supported Python versions would be helpful in the README file.
  2. Formatting issues are present in the codebase. My local test is excerpted at the end of this review for your reference.
  3. A repostatus.org badge in the README file might be useful to indicate the status of the package.

Additional info is provided below:
My local test environment is created via conda with following packages:

  • Python 3.12.10
  • numpy 2.2.5
  • pandas 2.2.3
  • pytest 8.3.5
  • flake8 7.2.0
  • solar-data-tools 1.7.1

Testing lint using flake8 on commit 18e2939bcf673eb2c234353e142a9152b7db4c66, shows some formatting issues.
Some of them are:

./solardatatools/clear_day_detection.py:60:80: E501 line too long (105 > 79 characters)
./solardatatools/clear_day_detection.py:61:80: E501 line too long (99 > 79 characters)
./solardatatools/clear_day_detection.py:63:80: E501 line too long (118 > 79 characters)
./solardatatools/clear_day_detection.py:65:80: E501 line too long (81 > 79 characters)
./solardatatools/clear_day_detection.py:71:80: E501 line too long (83 > 79 characters)
./solardatatools/clear_day_detection.py:72:80: E501 line too long (81 > 79 characters)
./solardatatools/clear_day_detection.py:78:80: E501 line too long (80 > 79 characters)
./solardatatools/clear_day_detection.py:88:80: E501 line too long (111 > 79 characters)
./solardatatools/clear_day_detection.py:96:80: E501 line too long (84 > 79 characters)
./solardatatools/clear_day_detection.py:98:80: E501 line too long (91 > 79 characters)
./solardatatools/clear_time_labeling.py:30:80: E501 line too long (83 > 79 characters)
./solardatatools/clear_time_labeling.py:32:80: E501 line too long (82 > 79 characters)
./solardatatools/clear_time_labeling.py:40:80: E501 line too long (83 > 79 characters)
./solardatatools/clear_time_labeling.py:42:80: E501 line too long (85 > 79 characters)
./solardatatools/clear_time_labeling.py:43:80: E501 line too long (81 > 79 characters)
./solardatatools/data_filling.py:10:1: F401 'matplotlib.pyplot as plt' imported but unused
./solardatatools/data_filling.py:11:1: F401 'solardatatools.daytime.find_daytime' imported but unused
./solardatatools/data_handler.py:17:17: E401 multiple imports on one line
./solardatatools/data_handler.py:46:1: E402 module level import not at top of file

@cmarmo
Copy link
Member

cmarmo commented May 2, 2025

Thank you so much @jinningwang ! And congratulations on your defense!
We have officially all the reviews in!

@pluflou
Copy link
Author

pluflou commented May 2, 2025

Thank you so much everyone! We really appreciate your time and comments! I will work on getting the changes/responses back by the end of May.

@pluflou
Copy link
Author

pluflou commented May 23, 2025

Hi all,

Many thanks to @cdeline, @echedey-ls and @jinningwang for their reviews. I have created three PRs that address the reviewers' comments, as well as Issues that note things that were raised that weren't gating for this review for future work. Please feel free to review/comment as needed.

Open PRs

Open Issues (for future work)

If I missed anything, please let me know, otherwise, I'll wait for comments/approvals/confirmation before we merge the PRs. Thank you all!

@cmarmo
Copy link
Member

cmarmo commented Jun 1, 2025

@pluflou thank you for your work!
I believe you can merge the PRs related to the review, so the reviewers will have to check the main code base for the final acceptation: it will make life easier for them and spped up the final review.
What do you think?

@pluflou
Copy link
Author

pluflou commented Jun 1, 2025

@cmarmo ok great, that sounds reasonable to me! I'll merge it tomorrow and ping everyone when I'm done. Thank you!

@pluflou
Copy link
Author

pluflou commented Jun 9, 2025

Hi all, I have merged the changes to the main branch. Please let me know if you have any comments. Thank you!

@cmarmo
Copy link
Member

cmarmo commented Jun 10, 2025

Thank you @pluflou for your follow-up!
@cdeline , @echedey-ls , @jinningwang do you mind letting us know if your are happy with the changes and the answers to your comments?
Thanks a lot!

@cdeline
Copy link

cdeline commented Jun 10, 2025

Looks good to me. I pulled changes and tested notebooks for functionality, everything appears to be working. Thanks for your efforts!

@cmarmo
Copy link
Member

cmarmo commented Jun 10, 2025

Thank you @cdeline for your answer! Do you mind checking the checkbox (sorry for the lack of vocabulary...) accepting the package at the end of your review if you are happy with the changes? Thanks!

@jinningwang
Copy link

Thanks for the improvement and most changes are good to me.

One last concern is: Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)

  1. With flake8 7.2.0, I ran tests on slacgismo/solar-data-tools@792df3f, some format issues occurred.
    If there is a lint config file or linter specified, feel free to let me know
./sdt_dask/clients/local_client.py:61:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:62:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:70:80: E501 line too long (80 > 79 characters)
./sdt_dask/clients/local_client.py:80:80: E501 line too long (93 > 79 characters)
./sdt_dask/clients/local_client.py:85:80: E501 line too long (104 > 79 characters)
./sdt_dask/dask_tool/runner.py:3:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:4:80: E501 line too long (86 > 79 characters)
./sdt_dask/dask_tool/runner.py:75:80: E501 line too long (80 > 79 characters)
./sdt_dask/dask_tool/runner.py:89:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:118:80: E501 line too long (128 > 79 characters)
./sdt_dask/dask_tool/runner.py:135:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:156:80: E501 line too long (82 > 79 characters)
./sdt_dask/dask_tool/runner.py:201:80: E501 line too long (81 > 79 characters)
./sdt_dask/dask_tool/runner.py:214:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:57:80: E501 line too long (80 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:58:80: E501 line too long (80 > 79 characters)
./sdt_dask/dataplugs/S3Bucket_plug.py:75:80: E501 line too long (100 > 79 characters)
./sdt_dask/dataplugs/csv_plug.py:14:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/csv_plug.py:48:80: E501 line too long (82 > 79 characters)
./sdt_dask/dataplugs/dataplug.py:12:80: E501 line too long (81 > 79 characters)
./sdt_dask/dataplugs/pvdb_plug.py:22:80: E501 line too long (81 > 79 characters)
...
  1. I didn't find lint process in CI here, https://github.com/slacgismo/solar-data-tools/blob/792df3f325b87f11690e60848d1915422bf3fe12/.github/workflows/lint.yml#L4

A GitHub action might be useful for lint purpose and its integration in CI, https://github.com/marketplace/actions/lint-action

@pluflou
Copy link
Author

pluflou commented Jun 11, 2025

@cdeline @jinningwang Thank you so much for reviewing the changes!

@jinningwang I am using ruff for formatting, which may have different settings than flake8 (we can control them and make them match, but I left them mostly at default). I set up linting up using pre-commit hooks (you can see the instructions here on step 7), but you can also install ruff and run ruff check and ruff format. The settings for the ruff checks are in here. The workflow is running the linting check on this line. What you are seeing is due to the fact that ruff does not enforce E501 by default, and I did not add it, but it would be straightforward to do so if that's your recommendation. Let me known if you have other questions/your thoughts.

@jinningwang
Copy link

jinningwang commented Jun 11, 2025 via email

@pluflou
Copy link
Author

pluflou commented Jun 12, 2025

Thank you @jinningwang for your review! We really appreciate it.

@cmarmo Could you let me know what the next steps are? We also have a JOSS paper in the repo, but I'm not sure what the process is after this.

@cmarmo
Copy link
Member

cmarmo commented Jun 13, 2025

@pflou, as soon as @echedey-ls will finalise his answer, we can declare the package accepted and move forward with the JOSS submission.
Luckily we have a nice checklist for that too ... :)

@echedey-ls
Copy link

Everything's ok from my side. I had already seen those PRs, not the main code, due to my lack of free time lately. Good job!

@cmarmo
Copy link
Member

cmarmo commented Jun 13, 2025

Wonderful! I guess it's time to move to the next step then.

🎉 Solar Data Tools has been approved by pyOpenSci! Thank you @pluflou for submitting and many thanks to @cdeline, @echedey-ls and @jinningwang for reviewing this package! 😸

Author Wrap Up Tasks

There are a few things left to do to wrap up this submission:

  • Activate Zenodo watching the repo if you haven't already done so.
  • Tag and create a release to create a Zenodo version and DOI.
  • Add the badge for pyOpenSci peer-review to the README.md of Solar Data Tools. The badge should be [![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/issue-number).
  • Please fill out the post-review survey. All maintainers and reviewers should fill this out.

It looks like you would like to submit this package to JOSS. Here are the next steps:

  • Once the JOSS issue is opened for the package, we strongly suggest that you subscribe to issue updates. This will allow you to continue to update the issue labels on this review as it goes through the JOSS process.
  • Login to the JOSS website and fill out the JOSS submission form using your Zenodo DOI. When you fill out the form, be sure to mention and link to the approved pyOpenSci review. JOSS will tag your package for expedited review if it is already pyOpenSci approved.
  • Wait for a JOSS editor to approve the presubmission (which includes a scope check).
  • Once the package is approved by JOSS, you will be given instructions by JOSS about updating the citation information in your README file.
  • When the JOSS review is complete, add a comment to your review in the pyOpenSci software-review repo here that it has been approved by JOSS. An editor will then add the JOSS-approved label to this issue.

Editor Final Checks

Please complete the final steps to wrap up this review. Editor, please do the following:

  • Make sure that the maintainers filled out the post-review survey
  • Invite the maintainers to submit a blog post highlighting their package. Feel free to use / adapt language found in this comment to help guide the author.
  • Change the status tag of the issue to 6/pyOS-approved6 🚀🚀🚀.
  • Invite the package maintainer(s) and both reviewers to slack if they wish to join.
  • If the author submits to JOSS, please continue to update the labels for JOSS on this issue until the author is accepted (do not remove the 6/pyOS-approved label). Once accepted add the label 9/joss-approved to the issue. Skip this check if the package is not submitted to JOSS.
  • If the package is JOSS-accepted please add the JOSS doi to the YAML at the top of the issue.

If you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the peer-review-guide.

@lwasser lwasser moved this from under-review to pyos-accepted in peer-review-status Jun 13, 2025
@cmarmo
Copy link
Member

cmarmo commented Jun 13, 2025

@pluflou, @bmeyers, @cdeline, @echedey-ls and @jinningwang, please let me know if you are interested in an invite to the pyopensci Slack, I will be happy to provide you with it.

Also if the authors are interested in writing a blogpost about the review process pyopensci can provide the infrastructure to host it.

@jinningwang
Copy link

jinningwang commented Jun 13, 2025 via email

@cmarmo
Copy link
Member

cmarmo commented Jun 13, 2025

I can join it. Do I need to register it first?

@jinningwang you are right, you are already in! No need for an invite! 🙂

@pluflou
Copy link
Author

pluflou commented Jun 13, 2025

Thank you @cmarmo! Please add me to the Slack channel! I update the remaining tasks below, I will update as things progress with JOSS. Who submits the JOSS issue?

Author Wrap Up Tasks

  • Activate Zenodo watching the repo if you haven't already done so.

  • Tag and create a release to create a Zenodo version and DOI.

  • Add the badge for pyOpenSci peer-review to the README.md of Solar Data Tools. The badge should be [![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/issue-number).

  • Please fill out the post-review survey. All maintainers and reviewers should fill this out.

  • Once the JOSS issue is opened for the package, we strongly suggest that you subscribe to issue updates. This will allow you to continue to update the issue labels on this review as it goes through the JOSS process.

  • Login to the JOSS website and fill out the JOSS submission form using your Zenodo DOI. When you fill out the form, be sure to mention and link to the approved pyOpenSci review. JOSS will tag your package for expedited review if it is already pyOpenSci approved.

  • Wait for a JOSS editor to approve the presubmission (which includes a scope check).

  • Once the package is approved by JOSS, you will be given instructions by JOSS about updating the citation information in your README file.

  • When the JOSS review is complete, add a comment to your review in the pyOpenSci software-review repo here that it has been approved by JOSS. An editor will then add the JOSS-approved label to this issue.

@cmarmo
Copy link
Member

cmarmo commented Jun 14, 2025

Thank you @pluflou ! Do you mind creating a new release containing the modifications originated by the review? The 1.7.1 is dated back to April. The new one will be the version accepted by pyOpenSci.

Who submits the JOSS issue?

The authors / maintainers of the package take care of the submission: be sure to mention and link to the approved pyOpenSci review. Thanks a lot!
I will take care of the labelling of this issue while the JOSS submission moves forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: pyos-accepted
Development

No branches or pull requests

8 participants