https://github.com/sunsetmkt/jupyterlite-xeus
https://github.com/sunsetmkt/jupyterlite-xeus
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sunsetmkt/jupyterlite-xeus
- Owner: SunsetMkt
- Created: 2025-06-24T04:34:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-29T12:31:41.000Z (about 1 year ago)
- Last Synced: 2025-09-24T05:50:00.689Z (10 months ago)
- Language: Jupyter Notebook
- Homepage: https://jupyterlite-xeus.vercel.app
- Size: 2.86 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Xeus-Lite demo
[](https://jupyterlite.github.io/xeus-lite-demo/notebooks/?path=demo.ipynb)
This GitHub template allows you to create deployments of JupyterLite with a custom set of conda packages.
## Warning for multiple language kernels in one deployment
Each kernel and its dependencies should be separated to different environments and load them with `jupyter_lite_config.json`:
```json
{
"XeusAddon": {
"environment_file": [
"environment-python.yml",
"environment-js.yml",
"environment-r.yml",
"environment-cpp.yml",
"environment-lua.yml",
"environment-nelson.yml"
]
}
}
```
Otherwise there will be a conflict while loading any of the kernels.
## 💡 How to make your own deployment
Creating a new deployment can be done in three easy steps:
**Step 1: Apply the GitHub template**
1. Click the **"Use this template"** button in the upper right corner of the GitHub repository.
2. Choose a name for your project and select the GitHub organization where you want to create it.
3. Then hit **"Create repository from template"** to finalize the setup.
**Step 2: Enable building the GitHub pages from GitHub actions.**
1. Once your repository is created, enable GitHub Pages by configuring GitHub Actions. This will build and deploy your site automatically.
2. Your deployment will be accessible at the following URL: https://{USERNAME}.github.io/{DEMO_REPO_NAME}.
**Step 3: Customize your conda environment**
1. Update your `environment.yml` file to include the required packages.
2. This ensures that your environment has all the necessary dependencies.
## 🎬 Visual Guide
For a step-by-step visual guide, check out the screencast below:
## 📦 How to install kernels and packages
You can install specific kernels and extra packages by adding them to the `environment.yml` file.
See https://jupyterlite-xeus.readthedocs.io/en/latest/environment.html for more documentation.
### Example 1: JupyterLite with NumPy and Matplotlib
To create a JupyterLite deployment with NumPy and Matplotlib pre-installed, edit the `environment.yml` file as follows:
```yml
name: xeus-kernel
channels:
- https://repo.prefix.dev/emscripten-forge-dev
- https://repo.prefix.dev/conda-forge
dependencies:
- xeus-python
- numpy
- matplotlib
```
### Example 2: JupyterLite with R and coursekata
To use the R kernel and the coursekata package, edit the environment.yml file as follows:
```yml
name: xeus-kernel
channels:
- https://repo.prefix.dev/emscripten-forge-dev
- https://repo.prefix.dev/conda-forge
dependencies:
- xeus-r
- r-coursekata
```
### Example 3: JupyterLite with C++
To use the C++ kernel, edit the environment.yml file as follows:
```yml
name: xeus-kernel
channels:
- https://repo.prefix.dev/emscripten-forge-dev
- https://repo.prefix.dev/conda-forge
dependencies:
- xeus-cpp
```