Skip to content

Commit 56bb67c

Browse files
lwasserlwasser
authored
CONTENT: Overhaul of packages and peer review page (pyOpenSci#87)
☑️ Updates the packages landing page with simpler cleaner content ☑️ Cleans up the package list that we have (on the way to a packages catalog which is the ultimate goal ☑️ Combines packages and peer review into one tidy page for cleaner appearance ☑️ Cleans up some styles here and there.
1 parent 924941e commit 56bb67c

File tree

4 files changed

+142
-16
lines changed

4 files changed

+142
-16
lines changed

‎_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ defaults:
298298
comments: # true
299299
share: true
300300
related: true
301+
toc: true
301302
- scope:
302303
path: ""
303304
type: posts
@@ -308,3 +309,4 @@ defaults:
308309
comments: # true
309310
share: true
310311
related: true
312+

‎_data/navigation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# main links
22
main:
3-
- title: "Resources"
4-
url: /resources/
5-
- title: "Our Packages"
3+
- title: "Peer Review & Packages"
64
url: /python-packages/
75
- title: "Blog"
86
url: /blog/
7+
- title: "Resources"
8+
url: /resources/
99
- title: "Contributors"
1010
url: /contributors/
1111
- title: "Get In Touch"

‎_pages/python-packages.md

Lines changed: 130 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,151 @@
11
---
22
layout: single
33
permalink: /python-packages/
4-
title: "pyOpenSci Accepted Packages and Under Review Packages"
4+
title: "pyOpenSci Open Peer Review & Accepted Packages"
55
classes:
66
header:
77
overlay_image: images/header.jpg
88
overlay_filter: 0.6
9+
intro:
10+
- 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."
11+
toc: true
912
---
1013

11-
## About pyOpenSci Packages
14+
{% include feature_row id="intro" type="center" %}
15+
16+
17+
<div class="feature__wrapper">
18+
19+
<div class="feature__item ">
20+
<div class="archive__item cards">
21+
<div class="archive__item-body">
22+
<h2 class="archive__item-title">Ready to Submit a Package for Review?</h2>
23+
<div class="archive__item-excerpt">
24+
<p>You're in the right place! Learn about the steps to submit a package
25+
for open peer review in our guidebook. </p>
26+
</div>
27+
<p><a href="https://www.pyopensci.org/contributing-guide/open-source-software-submissions/author-guide.html" class="btn btn--inverse"><i class="fas fa-angle-right"></i> View our Author Guide </a></p>
28+
</div>
29+
</div>
30+
</div>
31+
32+
<div class="feature__item">
33+
<div class="archive__item cards">
34+
<div class="archive__item-body">
35+
<h2 class="archive__item-title">Want to Review a Python Package for Us?</h2>
36+
<div class="archive__item-excerpt">
37+
<p>We could use your help! Fill our our reviewer form. We will
38+
contact you if we have a package that we need reviewers for.
39+
It's OK if you've never reviewed a package before! We'll walk you
40+
through it. </p>
41+
</div>
42+
<p><a href="https://forms.gle/GHfxvmS47nQFDcBM6" class="btn btn--inverse"><i class="fas fa-angle-right"></i>
43+
Signup Now (Google Form) </a></p>
44+
</div>
45+
</div>
46+
</div>
47+
48+
<div class="feature__item">
49+
<div class="archive__item cards">
50+
<div class="archive__item-body">
51+
<h2 class="archive__item-title">See Our Review Process in Action</h2>
52+
<div class="archive__item-excerpt">
53+
<p>Our reviewers happen in GitHub issues. This means that anyone can
54+
check in on any part of any review and read all of the conversation.
55+
Check it out.</p>
56+
</div>
57+
<p><a href="" class="btn btn--inverse"><i class="fas fa-angle-right"></i> See Open Reviews </a></p>
58+
</div>
59+
</div>
60+
</div>
61+
</div>
62+
63+
# Why Peer Review for Python Scientific Software?
64+
Peer review of Python scientific software addresses several challenges in the
65+
open source community:
66+
67+
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.
68+
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.
69+
3. **Removed Redundancy:** Peer review addresses the issue of multiple tools on pyPi that perform similar tasks but have varying levels of documenation, support and maintainence. One maintained package that is broadly useful and maintained will help scientists select tools that they can rely on.
70+
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 maintainance 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.
71+
5. **Community:** At the core of peer review is community around the tools that scientists need to process their data.
72+
73+
## Who Can Submit a Package?
1274
pyOpenSci packages are community developed, submitted and reviewed. Anyone is
1375
welcome to submit a package to pyOpenSci to be reviewed. Once the package is reviewed,
1476
and accepted, pyOpenSci will promote it as a peer-reviewed tool for science!
1577

16-
<a href="https://www.pyopensci.org/contributing-guide/open-source-software-peer-review/aims-and-scope.html" target="_blank">Learn More About the Review And Submission Process in our online guidebook. </a>
78+
<div class="notice" markdown="1">
79+
## What's the difference between pyOpenSci and JOSS?
80+
81+
> You don't have to chose between pyOpenSci and JOSS; You can submit your package to both.
82+
83+
pyOpenSci and [the Journal of Open Source Software (JOSS)](https://joss.theoj.org/)
84+
are complementary, partner organizations; and you don't have to chose one or the
85+
other! After a package to pyOpenSci has been reviewed and accepted by pyOpenSci
86+
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
87+
for packages that it will review. For instance while pyOpenSci will review and
88+
accept API wrappers, JOSS won't.
89+
90+
If your package is accepted by pyOpenSci and in scope for JOSS, JOSS will fast
91+
track your package through their process given it was already reviewed by us.
92+
Once accepted by JOSS, you now have both a pyOpenSci acceptance and one by JOSS.
93+
Joss will then give you a cross-ref supported DOI for citation.
94+
95+
### Why Two Review Processes JOSS and pyOpenSci?
96+
97+
the pyOpenSci review process is different from that of JOSS in a few ways:
98+
* pyOpenSci is specific to the Python community and thus will enforce community specific python specific standards.
99+
* pyOpenSci places heavy emphasis on documentation and usability in our reviews and associated standardization of both.
100+
* pyOpenSci builds community around and visibility for it's tools.
101+
* pyOpenSci supports long term tool maintenance.
102+
103+
104+
JOSS reviews are [more limited in scope](https://joss.readthedocs.io/en/latest/review_criteria.html) compared to pyOpenSci and the
105+
[submission criteria](https://joss.readthedocs.io/en/latest/review_criteria.html)
106+
are, in places, less stringent than those of pyOpenSci.
107+
</div>
108+
109+
110+
111+
112+
17113

18114
## PyOpenSci Accepted Packages
115+
<!--TODO: This would be better as rows of 3 vs 4; also adjust font size in cards > -->
19116
The package below have already been through our review process and are accepted
20117
as pyOpenSci packages.
21118

22-
<div>
23-
{% for apackage in site.data.packages %}
24-
<h2><a href="{{ apackage.link }}" target="_blank"> {{ apackage.package-name }} </a></h2>
25-
<p class="contrib_org">MAINTAINER: {{ apackage.maintainer }}</p>
26-
<p>{{ apackage.description | markdownify }}</p>
27-
{% endfor %}
119+
<div class="entries-grid">
120+
{% for apackage in site.data.packages %}
121+
<div class="grid__item cards">
122+
<article class="archive__item" itemscope="" itemtype="https://schema.org/CreativeWork">
123+
<div class="archive__item-teaser">
124+
<img src="/minimal-mistakes/assets/images/unsplash-gallery-image-1-th.jpg" alt="">
125+
</div>
126+
<h2 class="archive__item-title no_toc" itemprop="headline">
127+
<a href="{{ apackage.link }}" rel="permalink">
128+
{{ apackage.package-name }}
129+
</a>
130+
</h2>
131+
<p class="page__meta">
132+
<span class="page__meta-readtime"><i class="fas fa-feather" aria-hidden="true"></i>
133+
<!-- Commas in between authors -->
134+
{% for aMaintainer in apackage.maintainer %}
135+
{{ aMaintainer }}{% if forloop.last == false %}, {% endif %}
136+
{% endfor %}
137+
</span>
138+
</p>
139+
<span class="narrow">
140+
<p class="archive__item-excerpt narrow" itemprop="description">{{ apackage.description | markdownify }}
141+
</p>
142+
</span>
143+
</article>
144+
</div>
145+
{% endfor %}
28146
</div>
29147

30-
<br clear="both">
31-
## PyOpenSci Packages In Review
32148

33-
Check out our <a href="https://github.com/pyOpenSci/software-review/issues" target="_blank">Packages Current Under review in the issues portion of our software-review github repo to see our current community submissions.</a> Anyone is welcome to submit a package to pyopensci.
149+
150+
151+
<br clear="both">

‎assets/css/main.scss

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ body {font-size:90%}
7272
}
7373
}
7474

75+
/* Adjust font size on cards */
76+
.narrow {
77+
font-size: .92em!important;
78+
}
79+
7580
/* Fix buttons and text in notice boxes */
7681
.notice--info .btn.btn--info {
7782
color:#fff;
@@ -90,9 +95,10 @@ body {font-size:90%}
9095
text-decoration: none;
9196
font-size: 1.0em;
9297
}
98+
9399
/* Adding a 3 col grid */
94100

95-
101+
96102

97103
@charset "utf-8";
98104
@import "minimal-mistakes/skins/{{ site.minimal_mistakes_skin | default: 'default' }}"; // skin

0 commit comments

Comments
 (0)