jejjohnson / oceanbench

OceanBench - SSH edition
https://jejjohnson.github.io/oceanbench/
MIT License
17 stars 2 forks source link

Add Simple JupyterBook Support for the docs #22

Open jejjohnson opened 1 year ago

jejjohnson commented 1 year ago

I want a lot of notebooks showcasing how we can use this tool. The examples will get this rolling!


Previous Work

ML4Floods

I like the quality of the notebooks within this repo. The showcase the use case as well as some of the individual functionality.

Plum

This is a simple package for multiple-dispatch in python. They have a nice minimal set of docs which uses JupyterBook. The filepath and pages are very minimal. It also has automatic API generation

GPJax

A nice set of documentation! It's also worth checking out jupytext to have an easy transition between ipynb files and md files. See tutorial.