A set of tutorials for the tskit ecosystem build using Jupyter Book, served up at https://tskit.dev/tutorials/.
Merges to this repo will trigger a rebuild of the tskit.dev web site via an action on the tskit-site repository: look there for any deployment issues.
Under construction
These are quick notes for developers while the real developers page is under construction.
Install the Python requirements from requirements.txt:
$ python -m pip install -r requirements.txt
You will also need a working R installation with reticulate and irkernel installed.
This command should do the trick:
$ R -e 'options(repos=c(CRAN="http://cran.r-project.org")); install.packages(c("reticulate", "IRkernel")); IRkernel::installspec()'
- To add a new tutorial, create a Markdown file and add its name to
_toc.yml. - If you are basing the tutorial on an existing notebook, use jupytext to convert the notebook into the right format.
- To build locally, run
make. The output tells you where to find the builtHTMLfile(s). - Pages rendered at https://tskit.dev/tutorials.
- Pages might take a while to be updated after a new tutorial is merged.
If you have an idea for a tutorial, please open an issue to discuss.