pyopensci.github.io

This repo contains the source code for the pyOpenSci.org website. Contributions are welcome. Thank you pyOpenSci contributors!!

Getting Started

Please explore the site and let us know what your think. If you find a bug or have a suggestion for a new feature, open an issue.

Next Steps

If you are interested in contributing to pyOpenSci, please read about how we work in pyOpenSci's organization-wide contributing guide. This repo's CONTRIBUTING.md file provides more information about contributing to our website, our Python Packaging Guide and our Peer Review Guide.

Installation and Development

Have you decided to contribute? We use the Jekyll framework for creating this site. To set up a development environment and run the site locally, follow these steps:

1. Install ruby and bundler on your machine. See the Jekyll docs for instructions.
2. Fork and clone this repository.
3. Run bundle install in the root of the cloned repository directory. This will install the gems needed to run the site locally.
4. Run bundle exec jekyll serve to start the jekyll web server. NOTE: if you want the page to automatically reload, use: bundle exec jekyll serve --live reload. This requires Jekyll 3.7 or higher.
5. Open your browser and navigate to http://127.0.0.1:4000/.

Please test your changes locally prior to submitting a pull request (PR).

Want to build with new blog posts to be published in the future?

If you are publishing a blog post with a date that is in the future, you can build the site locally using the --future option to view it as follows:

bundle exec jekyll serve --future.

Images and webp

We try to keep the image size of our graphics as small/compressed as possible. To enable webp on your system, you first need to install it:

For MAC: brew install webp

Linux: sudo apt-get install imagemagick

You can convert a directory of PNG images associated with a blog post that you write using:

for file in *.png; do cwebp "$file" -o "${file%.*}.webp"; done

or a single image

cwebp input-image.png -o output-image.webp

Below is an example of adding a figure to a post that has both webp and .png formats to support older and newer browsers.

<figure>
<picture>
  <source srcset="/images/image-name.webp" type="image/webp">
  <img src="/images/image-name.png" alt="Alt text here" />
</picture>
</figure>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Anita Graser 👀	Niels Bantilan 👀	Ivan Ogasawara 👀	David Nicholson 📝	Jenny Palomino 🤔 👀 💻	Alex Batisse 🤔 👀	Semidán Robaina, Ph.D. 💻
Barnabas Bulpett (He/Him) 👀 💻 🎨	Juanita Gomez 💻 👀	Sarah Kaiser 💻 👀	C.A.M. Gerlach 💻 🎨 👀	Nhat (Jonny) Tran 👀 💻	Teddy Groves 💻 👀	Mike Sarahan 💻 👀
Thomas J. Fan 💻 👀	Szabolcs Horvát 💻 👀	Jonny Saunders 💻 👀	Kerry McAdams 💻 👀	Ricky Nilsson 💻 👀	Carol Willing 💻 👀	Eliot Robson 💻 👀
P. L. Lim 💻 👀	Andrew Nesbitt 💻 👀	Jesse Mostipak 💻 👀	Felipe Moreno 💻 👀	Sneha Yadav 💻 👀	Emily Zhang 💻 👀	Filipe Laíns 💻 👀
Steven Silvester 👀	Megan Sosey 👀	Patrick J. Roddy 💻 👀	Gabriel Stefanini Vicente 💻 👀	SeanAverS 💻 👀	Han 💻 👀	Jon Kiparsky 🐛 🤔
Tracy Teal 👀 🤔	Inessa Pawson 💻 👀	Seth Michael Larson 👀	Erik Whiting 👀	Hugo van Kemenade 💻 👀	Raktim Mukhopadhyay 💻 👀	Hans Moritz Günther 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!