https://github.com/tskit-dev/tutorials
A set of tutorials for msprime and tskit.
https://github.com/tskit-dev/tutorials
Last synced: 3 months ago
JSON representation
A set of tutorials for msprime and tskit.
- Host: GitHub
- URL: https://github.com/tskit-dev/tutorials
- Owner: tskit-dev
- License: cc-by-4.0
- Created: 2018-02-17T15:21:14.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-12-29T14:20:19.000Z (4 months ago)
- Last Synced: 2026-01-01T17:33:11.138Z (4 months ago)
- Language: Jupyter Notebook
- Size: 29.8 MB
- Stars: 20
- Watchers: 12
- Forks: 17
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# tutorials
A set of tutorials for the tskit ecosystem build using
[Jupyter Book](https://jupyterbook.org/), served up at
[https://tskit.dev/tutorials/](https://tskit.dev/tutorials/).
Merges to this repo will trigger a rebuild of the
[tskit.dev web site](https://tskit.dev/) via an
[action](https://github.com/tskit-dev/tskit-site/actions) on the
[tskit-site repository](https://github.com/tskit-dev/tskit-site/):
look there for any deployment issues.
**Under construction**
These are quick notes for developers while the real developers page is
under construction.
# Requirements
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 'install.packages(c("reticulate", "IRkernel")); IRkernel::installspec()'
```
# Building tutorials
- 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](https://github.com/mwouts/jupytext) to convert the notebook into
the right format.
- To build locally, run ``make``. The output tells you where to find the
built `HTML` file(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.