pyOpenSci Lessons

GitHub release (latest by date)

What is pyOpenSci?

pyOpenSci is devoted to building diverse, supportive community around the Python open source tools that drive open science. We do this through:

open peer review
mentorship
training

pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives.

About this repo

This repo contains a set of lessons being developed for pyOpenSci training events. as of early October 2024 it is a new repo being rapidly developed.

Please expect the contents to change at any time! With that said all contributions are always welcome!

Contributing statement

How to setup

This repository contains the source files for the pyOpenSci Tutorials.

Code formatting in Jupyter

If yo are working on the notebooks, you may want to apply ruff for code formatting. Instructions on how to set this up in Jupyter Lab are below:

https://gist.github.com/jbwhit/eecdd1cac2756df85ad165f437445b0b

Build the guidebook locally

Our guidebook is built with Sphinx which is a documentation tool and uses the pyos-sphinx-theme which customizes the pydata-sphinx-theme.

The easiest way to build our documentation is to use the nox automation tool, a tool for quickly building environments and running commands within them.

Using nox ensures that your environment has all the dependencies needed to build the documentation.

To build, follow these steps:

Install nox
```
python -m pip install nox
```
Build the documentation:
```
nox -s docs
```

This should create a local environment in a .nox folder, build the documentation (as specified in the noxfile.py configuration), and the output will be in _build/html.

To build live documentation that updates when you update local files, run the following command: