Skip to content

Commit e2115a7

Browse files
authored
Minor docs & env updates on the Jupyter kernel (#2767)
1 parent 1f6a208 commit e2115a7

File tree

3 files changed

+32
-38
lines changed

3 files changed

+32
-38
lines changed

appveyor.yml

-24
This file was deleted.

ci/azure_install_macos.sh

-14
This file was deleted.

doc/src/installation.md

+32
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,38 @@ You can run the following examples manually in a terminal:
185185
./src/bin/lpython --show-c examples/expr2.py
186186
```
187187

188+
## Enabling the Jupyter Kernel
189+
190+
To install the Jupyter kernel, install the following Conda packages also:
191+
```
192+
conda install xeus=5.1.0 xeus-zmq=3.0.0 nlohmann_json
193+
```
194+
and enable the kernel by `-DWITH_XEUS=yes` and install into `$CONDA_PREFIX`. For
195+
example:
196+
```
197+
cmake . -GNinja \
198+
-DCMAKE_BUILD_TYPE=Debug \
199+
-DWITH_LLVM=yes \
200+
-DWITH_XEUS=yes \
201+
-DCMAKE_PREFIX_PATH="$CONDA_PREFIX" \
202+
-DCMAKE_INSTALL_PREFIX="$CONDA_PREFIX"
203+
.
204+
ninja install
205+
```
206+
To use it, install Jupyter (`conda install jupyter`) and test that the LPython
207+
kernel was found:
208+
```
209+
jupyter kernelspec list --json
210+
```
211+
Then launch a Jupyter notebook as follows:
212+
```
213+
jupyter notebook
214+
```
215+
Click `New->LPython`. To launch a terminal jupyter LPython console:
216+
```
217+
jupyter console --kernel=lpython
218+
```
219+
188220
## Found a bug?
189221
Please report any bugs you find at our issue tracker [here](https://github.com/lcompilers/lpython/issues). Or, even better, fork the repository on GitHub and create a Pull Request (PR).
190222

0 commit comments

Comments
 (0)