Skip to content

Commit d06bed7

Browse files
authored
Update README to make it less xeus-python focused (#49)
1 parent 5b21a33 commit d06bed7

File tree

2 files changed

+36
-25
lines changed

2 files changed

+36
-25
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,27 @@
1-
# xeus-python + JupyterLite demo
1+
# xeus kernels + JupyterLite demo
22

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

5-
xeus-python + JupyterLite deployed as a static site to GitHub Pages, for demo purposes.
5+
xeus kernels + JupyterLite deployed as a static site to GitHub Pages, for demo purposes.
66

77
## ✨ Try it in your browser ✨
88

99
https://jupyterlite.github.io/xeus-python-demo/notebooks/?path=demo.ipynb
1010

11-
## ≠ How does it compare to the Pyodide kernel?
12-
13-
#### Pyodide kernel:
14-
15-
- Is based on [Pyodide](https://github.com/pyodide/pyodide)
16-
- Uses [IPython](https://github.com/ipython/ipython) for the code execution (access to IPython magics, support for the inline Matplotlib backend, *etc*)
17-
- Provides a way to dynamically install packages with ``piplite`` (**e.g.** ``await piplite.install("ipywidgets")``)
18-
- **Does not support** sleeping with ``from time import sleep``
19-
- **Does not support** pre-installing packages
20-
21-
#### jupyterlite-xeus-python:
22-
23-
- Is based on [xeus-python](https://github.com/jupyter-xeus/xeus-python)
24-
- Uses [IPython](https://github.com/ipython/ipython) for the code execution (access to IPython magics, support for the inline Matplotlib backend, *etc*)
25-
- **Does not provide** a way to dynamically install packages (yet. We are working on building a ``mamba`` package manager for WASM)
26-
- **Supports** sleeping with ``from time import sleep``
27-
- **Supports** pre-installing packages from ``emscripten-forge`` and ``conda-forge``, by providing an ``environment.yml`` file defining the runtime environment
28-
2911
## 💡 How to make your own deployment
3012

3113
![Deploy your own](deploy.gif)
3214

3315
Then your site will be published under https://{USERNAME}.github.io/{DEMO_REPO_NAME}
3416

35-
## 📦 How to install extra packages
17+
## 📦 How to install kernels and packages
3618

37-
You can pre-install extra packages for xeus-python by adding them to the ``environment.yml`` file.
19+
You can install a specific kernels and extra packages by adding them to the ``environment.yml`` file.
3820

3921
For example, if you want to create a JupyterLite deployment with NumPy and Matplotlib pre-installed, you would need to edit the ``environment.yml`` file as following:
4022

4123
```yml
42-
name: xeus-python-kernel
24+
name: xeus-kernel
4325
channels:
4426
- https://repo.mamba.pm/emscripten-forge
4527
- conda-forge
@@ -49,7 +31,36 @@ dependencies:
4931
- matplotlib
5032
```
5133
34+
Instead, if you'd like to use the R kernel and the coursekata package pre-installed, you can edit the ``environment.yml`` as following:
35+
36+
```yml
37+
name: xeus-kernel
38+
channels:
39+
- https://repo.mamba.pm/emscripten-forge
40+
- conda-forge
41+
dependencies:
42+
- xeus-r
43+
- r-coursekata
44+
```
45+
5246
Only ``no-arch`` packages from ``conda-forge`` and packages from ``emscripten-forge`` can be installed.
5347
- **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.
5448
![](noarch.png)
5549
- **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.
50+
51+
## ≠ How does xeus-python lite compare to the Pyodide kernel?
52+
53+
#### Pyodide kernel:
54+
55+
- Is based on [Pyodide](https://github.com/pyodide/pyodide)
56+
- Provides a way to dynamically install packages with ``piplite`` (**e.g.** ``await piplite.install("ipywidgets")``)
57+
- **Does not support** sleeping with ``from time import sleep``
58+
- **Does not support** pre-installing packages
59+
60+
#### xeus-python lite:
61+
62+
- Is based on [xeus-python](https://github.com/jupyter-xeus/xeus-python)
63+
- **Does not provide** a way to dynamically install packages (yet. We are working on building a ``mamba`` package manager for WASM)
64+
- **Supports** sleeping with ``from time import sleep``
65+
- **Supports** pre-installing packages from ``emscripten-forge`` and ``conda-forge``, by providing an ``environment.yml`` file defining the runtime environment
66+

environment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
name: xeus-python-kernel
1+
name: xeus-kernel
22
channels:
33
- https://repo.mamba.pm/emscripten-forge
44
- conda-forge
55
dependencies:
6-
- python=3.11
6+
- python
77
- xeus-python
88
- ipycanvas

0 commit comments

Comments
 (0)