https://github.com/jupyter-xeus/xeus-wren
Jupyter kernel for the Wren programming language
https://github.com/jupyter-xeus/xeus-wren
Last synced: 3 months ago
JSON representation
Jupyter kernel for the Wren programming language
- Host: GitHub
- URL: https://github.com/jupyter-xeus/xeus-wren
- Owner: jupyter-xeus
- License: bsd-3-clause
- Created: 2021-09-20T07:44:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T11:18:13.000Z (about 1 year ago)
- Last Synced: 2025-03-26T21:38:15.291Z (4 months ago)
- Language: C++
- Homepage:
- Size: 101 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/DerThorsten/xeus-wren/actions/workflows/main.yml)
[](https://xeus-wrenreadthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/DerThorsten/xeus-wren/main?urlpath=/lab/tree/notebooks/xeus-wren.ipynb)
`xeus-wren` is a Jupyter kernel for wren based on the native implementation of the
Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).
## Installation
xeus-wren has not been packaged for the mamba (or conda) package manager.
To ensure that the installation works, it is preferable to install `xeus-wren` in a
fresh environment. It is also needed to use a
[miniforge](https://github.com/conda-forge/miniforge#mambaforge) or
[miniconda](https://conda.io/miniconda.html) installation because with the full
[anaconda](https://www.anaconda.com/) you may have a conflict with the `zeromq` library
which is already installed in the anaconda distribution.
The safest usage is to create an environment named `xeus-wren`
```bash
mamba create -n `xeus-wren`
source activate `xeus-wren`
```
### Installing from source
Or you can install it from the sources, you will first need to install dependencies
```bash
mamba install cmake xeus nlohmann_json cppzmq xtl jupyterlab -c conda-forge
```
Then you can compile the sources (replace `$CONDA_PREFIX` with a custom installation
prefix if need be)
```bash
mkdir build && cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make && make install
```
## Trying it online
To try out xeus-wren interactively in your web browser, just click on the binder link:
(Once Conda Package is Ready)
[](https://mybinder.org/v2/gh/DerThorsten/xeus-wren/main?urlpath=/lab/tree/notebooks/iwren.ipynb)
## Documentation
To get started with using `xeus-wren`, check out the full documentation
http://xeus-wren.readthedocs.io
## Dependencies
`xeus-wren` depends on
- [xeus](https://github.com/jupyter-xeus/xeus)
- [xtl](https://github.com/xtensor-stack/xtl)
- [nlohmann_json](https://github.com/nlohmann/json)
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a
development environment.
## License
This software is licensed under the `BSD 3-Clause License`. See the [LICENSE](LICENSE)
file for details.