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

Fix: peer review landing page #287

Merged
merged 23 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/package-grid.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

<div class="element-item cards {% for aCategory in apackage.categories %}
<div class="element-item cards bubble {% for aCategory in apackage.categories %}
{{ aCategory }}
{% endfor %}" data-category="data">
<article
Expand Down
203 changes: 94 additions & 109 deletions _pages/about-peer-review.md
Original file line number Diff line number Diff line change
@@ -1,152 +1,133 @@
---
layout: splash
permalink: /about-peer-review/
title: "About the pyOpenSci Open Peer Review Process"
title: "pyOpenSci Reviews Scientific Python Software"
header:
overlay_image: images/header.jpg
overlay_filter: 0.6
intro:
- excerpt: "Our open peer review process supports scientists getting credit for the work invested in open Python tools. It also supports standardization of packaging and improved package visibility."
- excerpt: "Our open peer review process facilitates scientists getting credit and recognition for the work they've invested in developing scientific Python tools. The peer review process also supports scientists in finding vetted and maintained software, which drives their open science workflows."
benefits_scientists:
- image_path: images/pyopensci-people-at-computer.jpg
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
excerpt: "Through our [partnerships with domain specific communities](/partners.html) our catalog of trusted tools for scientists across domains continues to grow."
title: "Scientists need trusted and vetted tools to support their open science workflows."
benefits_maintainers:
- image_path: images/pyopensci-people-at-computer.jpg
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
excerpt: "The pyOpenSci peer review process multiplies shared knowledge, making it easier for Pythonistas of all levels to accomplish challenging tasks, such as navigating the Python packaging ecosystem, with relative ease. And our diverse community supports scientific package maintainers in their efforts to develop and build robust software."
title: "pyOS software peer review benefits open source maintainers"
peer_review:
- image_path: images/pyopensci-people-at-computer.jpg
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
excerpt: "Software peer review, similar to the review of scientific papers, is a process where scientists vet software code, documentation and infrastructure. pyOpenSci leads an [open peer review process](https://www.pyopensci.org/software-peer-review/our-process/how-review-works.html) run by a community of dedicated volunteers. Reviews are supportive and fully transparent with the shared goal of improving the quality, usability and maintainability of the software that is driving open science.

* Diverse teams lead each review, enhancing the overall feedback quality."
title: "About peer review of scientific Python software"
- image_path: images/pyopensci-joss-partnership.png
alt: "A pencil sketch of a round table with people sitting around it from different backgrounds working on laptops and also writing together."
excerpt: "Our [partnership with JOSS](https://www.pyopensci.org/software-peer-review/partners/joss.html) means that you don't have to chose between pyOpenSci and JOSS. Simply submit your package to pyOS for review. If your package is accepted and in scope for JOSS, it will be fast-tracked through JOSS' review process. "
title: "Get published with JOSS through a pyOpenSci review"
get-involved:
- image_path:
title: "Become a pyOpenSci reviewer"
alt:
excerpt: "We could use your help! Fill our our reviewer form. We will contact you if we have a package that we need reviewers for. It's OK if you've never reviewed a package before! We'll walk you through it."
url: https://forms.gle/GHfxvmS47nQFDcBM6
btn_label: "> Sign-up Now (Google Form)"
btn_class: btn--inverse
- image_path:
title: "See Our Review Process in Action"
alt:
excerpt: "Our software review process is run using GitHub issues. This means that anyone can check in on any part of any review and read all of the conversation. Check it out."
url: https://github.com/pyOpenSci/software-submission
btn_label: "> See Open Reviews"
btn_class: btn--inverse
- image_path:
title: "Ready to Submit a Package for Review?"
alt:
excerpt: "To submit a package to us, you need to [open an issue in our peer review GitHub repository](https://github.com/pyOpenSci/software-submission/issues/new/choose). Learn about the steps to submit a package for open peer review in our guidebook."
url: https://www.pyopensci.org/python-package-guide/
btn_label: "> View our Author Guide"
btn_class: btn--inverse
toc: false
classes:
classes: flowing
---


{% include feature_row id="intro" type="center" %}

<!--TODO: this into a template -->

<div class="feature__wrapper">
<div class="feature__item ">
<div class="archive__item cards">
<div class="archive__item-body">
<h2 class="archive__item-title">Ready to Submit a Package for Review?</h2>
<div class="archive__item-excerpt">
<p>You're in the right place! Learn about the steps to submit a package
for open peer review in our guidebook. </p>
</div>
<p><a href="https://www.pyopensci.org/software-peer-review/how-to/author-guide.html" class="btn btn--inverse"><i class="fas fa-angle-right"></i> View our Author Guide </a></p>
</div>
</div>
</div>

<div class="feature__item">
<div class="archive__item cards">
<div class="archive__item-body">
<h2 class="archive__item-title">Want to Review a Python Package for Us?</h2>
<div class="archive__item-excerpt">
<p>We could use your help! Fill our our reviewer form. We will
contact you if we have a package that we need reviewers for.
It's OK if you've never reviewed a package before! We'll walk you
through it. </p>
</div>
<p><a href="https://forms.gle/GHfxvmS47nQFDcBM6" class="btn btn--inverse"><i class="fas fa-angle-right"></i>
Signup Now (Google Form) </a></p>
</div>
</div>
</div>

<div class="feature__item">
<div class="archive__item cards">
<div class="archive__item-body">
<h2 class="archive__item-title">See Our Review Process in Action</h2>
<div class="archive__item-excerpt">
<p>Our reviewers happen in GitHub issues. This means that anyone can
check in on any part of any review and read all of the conversation.
Check it out.</p>
</div>
<p><a href="https://github.com/pyOpenSci/software-review/issues" class="btn btn--inverse"><i class="fas fa-angle-right"></i> See Open Reviews </a></p>
</div>
</div>
</div>
</div>
<div class="pyos-section purple">
<div class="content" markdown="1">

## Our editorial board
{% include feature_row id="peer_review" type="left" %}

{: .clearall }
</div>
</div>

We value our volunteer editors. Learn more about what editors do and how we
select them here.
{% include div_purple_bottom.html %}

{% assign editors = site.data.contributors | where: 'editorial_board', true %}
{% assign editors = editors | sort: 'sort' %}

<div class="pyos-section" markdown="1">
<div class="content" markdown="1">

<div class="grid">
{% for aperson in editors %}
{% unless aperson.board %}
{% include people-grid.html %}
{% endunless %}
{% endfor %}
</div>
{% include feature_row id="benefits_scientists" type="right" %}
{% include feature_row id="benefits_maintainers" type="right" %}

<br clear="both">

<div class="wide__p_text" markdown="1">

## Why Peer Review for Python Scientific Software?

Peer review of Python scientific software addresses several challenges in the
open source community:
</div>
</div>

1. **Citations Support Credit & Acknowledgement:** Peer review provides credit and acknowledgement for the hard work invested in creating and supporting core tools that support open science workflows.
2. **Standard Packaging & Documentation:** Currently there are numerous ways to create a Python package. Peer review enforces standards thus promoting standardization of Python packaging across the scientific Python ecosystem.
3. **Removed Redundancy:** Peer review addresses the issue of multiple tools on pyPi that perform similar tasks but have varying levels of documentation, support and maintenance. One maintained package that is broadly useful and maintained will help scientists select tools that they can rely on.
4. **Long Term Maintenance:** Package maintainers often use their free time to work on Python tools. Once a package is reviewed by pyOpenSci we will keep in touch with the maintainer to ensure continued maintenance of the tool. If a maintainer needs to step down, we will try to find someone new to take over, or sunset the tool as needed.
5. **Community:** At the core of peer review is community around the tools that scientists need to process their data.
<!-- {% include div_purple_top.html %} -->

### Who can submit a package?
<div class="pyos-section purple">
<div class="content" markdown="1">

pyOpenSci packages are community developed, submitted and reviewed. Anyone is
welcome to submit a package to pyOpenSci to be reviewed. Once the package is reviewed,
and accepted, pyOpenSci will promote it as a peer-reviewed tool for science!
## Get involved with peer review

### How do I decide whether to submit to you or the Journal of Open Source Software (JOSS)
{% include feature_row_pyos id="get-involved" %}

You don't have to chose between pyOpenSci and JOSS. We have a collaboration with
JOSS where you can submit your package to us for review. If your package is accepted
and if it is in scope for JOSS, it will then be fast tracked through their
review process; they will only review your paper.md file. Consider this a
win-win!

</div>
</div>

<!--
<div class="notice" markdown="1">
## What's the difference between pyOpenSci and JOSS?
{% include div_purple_bottom.html %}
{: .clearall }

> You don't have to chose between pyOpenSci and JOSS; You can submit your package to both.
<div class="content noimage" markdown="1">

pyOpenSci and [the Journal of Open Source Software (JOSS)](https://joss.theoj.org/)
are complementary, partner organizations; and you don't have to chose one or the
other! After a package to pyOpenSci has been reviewed and accepted by pyOpenSci
you can chose to also register it with JOSS. JOSS has [more limited scope](https://joss.readthedocs.io/en/latest/review_criteria.html) of the
for packages that it will review. For instance while pyOpenSci will review and
accept API wrappers, JOSS won't.
## Meet our editorial board

If your package is accepted by pyOpenSci and in scope for JOSS, JOSS will fast
track your package through their process given it was already reviewed by us.
Once accepted by JOSS, you now have both a pyOpenSci acceptance and one by JOSS.
Joss will then give you a cross-ref supported DOI for citation.
The pyOpenSci software peer review process is led by a volunteer team of
editors from the scientific Python community. Editors do the following things:

### Why Two Review Processes JOSS and pyOpenSci?
* They find reviewers from diverse backgrounds who have a mixture of scientific domain and Python experience.
* They oversee the entire review process for a package ensuring it runs in a timely and efficient manner
* They support the submitting authors and reviewers in answering questions related to the review
* They determine whether that package should be accepted into the pyOpenSci ecosystem once the review has wrapped up.

the pyOpenSci review process is different from that of JOSS in a few ways:
* pyOpenSci is specific to the Python community and thus will enforce community specific python specific standards.
* pyOpenSci places heavy emphasis on documentation and usability in our reviews and associated standardization of both.
* pyOpenSci builds community around and visibility for it's tools.
* pyOpenSci supports long term tool maintenance.
Learn more about the
editor role at pyOpenSci [in our peer review guide.](https://www.pyopensci.org/software-peer-review/how-to/editors-guide.html)

{% assign editors = site.data.contributors | where: 'editorial_board', true %}
{% assign editors = editors | sort: 'sort' %}

JOSS reviews are [more limited in scope](https://joss.readthedocs.io/en/latest/review_criteria.html) compared to pyOpenSci and the
[submission criteria](https://joss.readthedocs.io/en/latest/review_criteria.html)
are, in places, less stringent than those of pyOpenSci.
<div class="grid clean">
{% for aperson in editors %}
{% unless aperson.board %}
{% include people-grid.html %}
{% endunless %}
{% endfor %}
</div>

<br clear="both">
</div>


-->

## Recently Accepted Python Packages
<div class="content">
<div class="feature__wrapper">
<h2> Recently Accepted scientific Python Packages</h2>

{% assign packages_sorted = site.data.packages | sort_natural: 'date_accepted' | reverse %}

Expand All @@ -159,3 +140,7 @@ are, in places, less stringent than those of pyOpenSci.
<br clear="both">

<a href="/python-packages/" class="btn btn--info">View All Accepted Packages <i class="fa fa-4 fa-arrow-circle-right" aria-hidden="true"></i></a>

</div>

</div>
4 changes: 2 additions & 2 deletions _sass/minimal-mistakes/_archive.scss
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,8 @@

.feature__wrapper {
@include clearfix();
margin-bottom: 2em;
border-bottom: 1px solid $border-color;
margin-bottom: .02em; //used to be 2em
// border-bottom: 1px solid $border-color;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove


.archive__item-title {
margin-bottom: 0;
Expand Down
6 changes: 5 additions & 1 deletion _sass/minimal-mistakes/_pyos-flowing-page.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.pyos-section {
padding: 20px;
padding: 0px;
&.purple {
background-color: #e2dfed; //d9d5e8; #cbc6e0;
position: relative;
Expand Down Expand Up @@ -40,4 +40,8 @@ svg.bottom {
max-width: 1280px;
margin-right: auto;
margin-left: auto;

&.noimage {
max-width: 900px;
}
}
35 changes: 18 additions & 17 deletions _sass/minimal-mistakes/_pyos-grid.scss
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
/* Create & style a 3x3 grid wrapper */
.grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
// minmax can be used to modify width
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
grid-gap: 10px;

h4.grid_title {
Expand Down Expand Up @@ -78,15 +79,29 @@
font-size: 1.1em!important;
}

.bubble:before {
content: "";
position: absolute;
z-index: -1;
top: -16px;
right: -16px;
background: #967eb6;
height: 32px;
width: 32px;
border-radius: 32px;
transform: scale(2);
transform-origin: 50% 50%;
transition: transform 0.15s ease-out;
}

.cards {
display: block;
top: 0px;
position: relative;
max-width: 362px;
background-color: #f1f0f1;;
border-radius: 4px;
padding: 32px 24px;
margin: 12px;
// padding: 32px 24px;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// padding: 32px 24px;

text-decoration: none;
z-index: 0;
overflow: hidden;
Expand Down Expand Up @@ -135,20 +150,6 @@
cursor: pointer;
}

&:before {
content: "";
position: absolute;
z-index: -1;
top: -16px;
right: -16px;
background: #967eb6;
height: 32px;
width: 32px;
border-radius: 32px;
transform: scale(2);
transform-origin: 50% 50%;
transition: transform 0.15s ease-out;
}

&:hover:before {
transform: scale(2.15);
Expand Down
Binary file added images/pyopensci-joss-partnership.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.