From cf3f5751b323ea9dd46a079858d693ab70d126e2 Mon Sep 17 00:00:00 2001 From: Yan Wong Date: Fri, 28 Nov 2025 13:57:25 +0000 Subject: [PATCH] Revise README for Tskit-based Demo Notebooks Updated the README to reflect the new Tskit-based demo notebooks and removed outdated information. --- README.md | 34 +++++++--------------------------- 1 file changed, 7 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ac8ac37..2305e45 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,18 @@ -# JupyterLite Demo +# Tskit-based Demo Notebooks in JupyterLite -[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/demo) +This is the source repository for notebooks hosted at -JupyterLite deployed as a static site to GitHub Pages, for demo purposes. +https://tskit.dev/explore/ -## ✨ Try it in your browser ✨ - -➡️ **https://jupyterlite.github.io/demo** - -![github-pages](https://user-images.githubusercontent.com/591645/120649478-18258400-c47d-11eb-80e5-185e52ff2702.gif) - -## Requirements - -JupyterLite is being tested against modern web browsers: - -- Firefox 90+ -- Chromium 89+ - -## Deploy your JupyterLite website on GitHub Pages - -Check out the guide on the JupyterLite documentation: https://jupyterlite.readthedocs.io/en/latest/quickstart/deploy.html - -## Further Information and Updates - -For more info, keep an eye on the JupyterLite documentation: +These notebooks run JupyterLite as a static site, with compiled versions of the lastest versions of tskit and msprime. They therefore provide pyodide access to the most recent released versions of these libraries. Notebooks can be used in any modern browser: - How-to Guides: https://jupyterlite.readthedocs.io/en/latest/howto/index.html - Reference: https://jupyterlite.readthedocs.io/en/latest/reference/index.html -This template provides the Pyodide kernel (`jupyterlite-pyodide-kernel`), the JavaScript kernel (`jupyterlite-javascript-kernel`), and the p5 kernel (`jupyterlite-p5-kernel`), along with other -optional utilities and extensions to make the JupyterLite experience more enjoyable. See the -[`requirements.txt` file](requirements.txt) for a list of all the dependencies provided. +## Generic information -For a template based on the Xeus kernel, see the [`jupyterlite/xeus-python-demo` repository](https://github.com/jupyterlite/xeus-python-demo) +This repo provides the Pyodide kernel (`jupyterlite-pyodide-kernel`), the JavaScript kernel (`jupyterlite-javascript-kernel`), and the p5 kernel (`jupyterlite-p5-kernel`), along with other +optional utilities and extensions to make the JupyterLite experience more enjoyable. ## Rebuilding Pyodide and packages from `pyodide-recipes`