Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Feb 11, 2025
1 parent b25cfa4 commit e8a02e1
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
# xeus kernels + JupyterLite demo
# Xeus-Lite demo

[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/xeus-lite-demo/notebooks/?path=demo.ipynb)

xeus kernels + JupyterLite deployed as a static site to GitHub Pages, for demo purposes.
This is a GitHub template that can be used to create deployments of JupyterLite including a custom set of conda packages.

## ✨ Try it in your browser ✨
## 💡 How to make your own deployment

https://jupyterlite.github.io/xeus-lite-demo/notebooks/?path=demo.ipynb
Creating a new deployment can be done in three steps:

## 💡 How to make your own deployment
1. Apply the GitHub template

![Deploy your own](deploy.gif)
- Hit the "Use this template" button in the upper right corner
- Pick a name and a GitHub organization for your project
- Then hit "Create repository from template" to complete the action

2. Enable building the GitHub pages from GitHub actions.

Your deployment is then published at URL https://{USERNAME}.github.io/{DEMO_REPO_NAME}

3. Specialize your conda environment

- You can then update your ``environment.yml`` file to include the required packages.

Check out the screencast below

Then your site will be published under https://{USERNAME}.github.io/{DEMO_REPO_NAME}
![Deploy your own](deploy.gif)

## 📦 How to install kernels and packages

Expand Down Expand Up @@ -44,23 +56,9 @@ dependencies:
```
Only ``no-arch`` packages from ``conda-forge`` and packages from ``emscripten-forge`` can be installed.
- **How do I know if a package is ``no-arch`` on ``conda-forge``?** ``no-arch`` means that the package is OS-independent, usually pure-python packages are ``no-arch``. To check if your package is ``no-arch`` on ``conda-forge``, check if the "Platform" entry is "no-arch" in the https://beta.mamba.pm/channels/conda-forge?tab=packages page. If your package is not ``no-arch`` but is a pure Python package, then you should probably update the feedstock to turn your package into a ``no-arch`` one.
![](noarch.png)
- **How do I know if my package is on ``emscripten-forge``?** You can see the list of packages pubished on ``emscripten-forge`` [here](https://beta.mamba.pm/channels/emscripten-forge?tab=packages). In case your package is missing, or it's not up-to-date, feel free to open an issue or a PR on https://github.com/emscripten-forge/recipes.
## ≠ How does xeus-python lite compare to the Pyodide kernel?
#### Pyodide kernel:
- Is based on [Pyodide](https://github.com/pyodide/pyodide)
- Provides a way to dynamically install packages with ``piplite`` (**e.g.** ``await piplite.install("ipywidgets")``)
- **Does not support** sleeping with ``from time import sleep``
- **Does not support** pre-installing packages
#### xeus-python lite:
- Is based on [xeus-python](https://github.com/jupyter-xeus/xeus-python)
- **Does not provide** a way to dynamically install packages (yet. We are working on building a ``mamba`` package manager for WASM)
- **Supports** sleeping with ``from time import sleep``
- **Supports** pre-installing packages from ``emscripten-forge`` and ``conda-forge``, by providing an ``environment.yml`` file defining the runtime environment
- **How do I know if my package is on ``emscripten-forge``?** You can see the list of packages pubished on ``emscripten-forge`` [here](https://beta.mamba.pm/channels/emscripten-forge?tab=packages). In case your package is missing, or it's not up-to-date, feel free to open an issue or a PR on https://github.com/emscripten-forge/recipes.

0 comments on commit e8a02e1

Please sign in to comment.