[X] I expect to maintain this package for at least 2 years. In case I need to step down as a maintainer, I'm open to support finding a replacement maintainer (team) if needed / if it makes sense for my package.
[ ] contains a README file with instructions for creating an environment for and installing the development version of the package.
[ ] includes documentation with examples for all functions and methods (examples in your docstring are optional but encouraged).
[ ] contains a getting-started tutorial with examples of using the package's essential functions and applications.
[ ] has a test suite.
[ ] has continuous integration setup to run tests, such as GitHub Actions, CircleCI, and/or others.
Publication Options
I want to automatically submit to JOSS.
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 the 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/.
[ ] The package is deposited in a long-term repository with the DOI listed below.
Package DOI
No response
Reviewer Options
[ ] 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.
Submitting Author
Test
Submitting Author Handle
Test
Maintainer 1
No response
Maintainer 1 Handle
No response
Maintainer 2
No response
Maintainer 2 Handle
No response
Maintainer 3
No response
Maintainer 3 Handle
No response
Maintainer 4
No response
Maintainer 4 Handle
No response
Maintainer 5
No response
Maintainer 5 Handle
No response
Package Name
Test
One-Line Description of Package
Test
Repository Link
Test
Version Submitted
Test
Link to Version
Test
Code of Conduct & Commitment to Maintain Package
Description
Test
Scope
Domain Specific Categories
Community Partnerships
Target Audience
Test
Scientific Applications
Test
Are there any other Python packages that accomplish the same thing?
If you answered yes in the previous question, please explain which packages and why.
No response
Pre-Submission Link
No response
Package Technical Checks
Publication Options
I want to automatically submit to JOSS.
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 the 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 ininst/
.[ ] The package is deposited in a long-term repository with the DOI listed below.
Package DOI
No response
Reviewer Options
Survey
Feedback
No response