pyOpenSci Open Peer Review Goals and Scope
pyOpenSci Open Peer Review Goals and Scope#
pyOpenSci has several goals to support the scientific Python open source community.
Packages with overlapping functionality: It’s easy to find multiple packages on
PyPIthat perform that same tasks (or overlapping tasks). When you submit to us, we ask that you know about other packages in our system that may do similar things. This check will help us connect maintainers who are working on similar goals. It will also help us in the long term reduce the number of overlapping packages, in various states of maintenance on
Improve package usability: Documentation makes it easier for scientists to use your tools. Our review process looks at documentation, quick start vignettes (code samples to get started) to make it easier for new users to get started using your package.
Standardize packaging: There are many different ways to create a Python package. We will embrace community driven standards created by organizations such as Scientific Python and help maintainers create more consistent infrastructure for their packages. In the long term consistent infrastructure will make it easier for new contributors to contribute too.
Long term maintenance: Most maintainers are not paid and thus work on tools in their free time. So what happens when a maintainer of a commonly used tool wants to step down? We will help maintainers find someone new to take over the reigns. If that doesn’t make sense we will help the maintainer gracefully sunset the package.
The need for community around and support for smaller Python packages that support open science.
Is Your Package in Scope For pyOpenSci Review?#
pyOpenSci reviews packages within a set of categories define below. If you are unsure whether your package fits into one of these categories, please open a pre-submission inquiry via a GitHub Issue to get feedback from one of our editors. We are happy to look at your package and help you understand whether it is in scope or not.
Data retrieval: Packages for accessing and downloading data from online sources. Includes wrappers for accessing APIs.
Data extraction: Packages that aid in retrieving data from unstructured sources such as text, images and PDFs.
Data munging: Tools for processing data from scientific data formats.
Data deposition: Tools for depositing data in scientific research repositories.
Reproducibility: Tools to scientists ensure that their research is reproducible. E.g. version control, automated testing, or citation tools.
Geospatial: Packages focused on the retrieval, manipulation, and analysis of spatial data.
Education: Packages to aid with instruction.
Data visualization: Packages for visualizing and analyzing data.
Notes on Scope Categories#
pyOpenSci is still developing as a community. If your scientific Python package does not fit into one of the categories or if you have any other questions, we’d encourage you to open a pre-submission inquiry. We’re happy to help.
Data visualization packages come in many varieties, ranging from small hyper-specific methods for one type of data to general, do-it-all packages (e.g. matplotlib). pyOpenSci accepts packages that are somewhere in between the two. If you’re interested in submitting your data visualization package, please open a pre-submission inquiry on first.
pyOpenSci encourages competition among packages, forking and re-implementation as they improve options of users. However, we strive to make packages in the pyOpenSci suite to represent our top recommendations for the tasks that they perform. We aim to avoid duplication of functionality of existing Python packages in any repo without significant improvements. A Python package that replicates the functionality of an existing package may be considered for inclusion in the pyOpenSci suite if it significantly improves on alternatives by being:
More open in licensing or development practices
Broader in functionality (e.g., providing access to more data sets, providing a greater suite of functions), but not only by duplicating additional packages
Better in usability and performance
Actively maintained while alternatives are poorly or no longer actively maintained
These factors should be considered as a whole to determine if the package is a significant improvement. A new package would not meet this standard only by following our package guidelines while others do not, unless this leads to a significant difference in the areas above.
We recommend that packages highlight differences from and improvements over
overlapping packages in their
README and/or vignettes or get started tutorials.
We encourage developers whose packages are not accepted due to overlap to still consider submittal to other repositories or journals.