Here you can find notebooks, which show you how to read in, plot and do simple analysis on some data sets published within (AC)³.
Running the notebooks¶
download them to your local machine
setup a venv or conda environment
install requirements
Run
Adding notebooks¶
Opening an issue¶
You can either open an issue on GitHub and upload a jupyter notebook there. Please provide a short explanation to which dataset your jupyter notebook belongs in the issue and a statement that we can use the content in the book.
You can find a template jupyter notebook here and download it with the download button on the top right.
Opening a pull request¶
The other option is to fork the whole repository, directly add a notebook in the books structure and open a pull request.
Here’s how to set up the ac3-book book for local development.
Fork the repo on GitHub.
Clone your fork locally.
Run
pixi installin the local directory to use pixi to set up the python environmentCreate a branch for local development and make changes locally. See the mystmd guide for help on syntax.
Build the book locally to see if the fully-rendered HTML version looks as intended.
cd book # change into the book directory pixi run myst start # start your local webserverCommit your changes and push your branch to your fork on GitHub.
Create a pull request through the GitHub website.