https://github.com/jupyter-xeus/xeus-nelson
Jupyter kernel for Nelson
https://github.com/jupyter-xeus/xeus-nelson
Last synced: 3 months ago
JSON representation
Jupyter kernel for Nelson
- Host: GitHub
- URL: https://github.com/jupyter-xeus/xeus-nelson
- Owner: jupyter-xeus
- License: lgpl-3.0
- Created: 2023-01-13T10:55:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T07:35:03.000Z (12 months ago)
- Last Synced: 2025-03-26T21:38:22.062Z (3 months ago)
- Language: C++
- Size: 86.9 KB
- Stars: 7
- Watchers: 3
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://github.com/jupyter-xeus/xeus-nelson/actions/workflows/main.yml)
[](https://xeus-nelson.readthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/jupyter-xeus/xeus-nelson/main?urlpath=/lab/tree/notebooks/xeus-nelson.ipynb)
`xeus-nelson` is a Jupyter kernel for nelson based on the native implementation of the
Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).
## Installation
xeus-nelson has not been packaged for the mamba (or conda) package manager.
To ensure that the installation works, it is preferable to install `xeus-nelson` 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-nelson`
```bash
mamba create -n `xeus-nelson`
source activate `xeus-nelson`
```
Then you can install in this environment `xeus-nelson` and its dependencies
```bash
mamba install`xeus-nelson` notebook -c conda-forge
```
### Installing from source
Or you can install it from the sources, you will first need to install dependencies
```bash
mamba install cmake cxx-compiler xeus-zmq nlohmann_json nelson-core 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
```
To try out xeus-nelson interactively in your web browser, just click on the binder link:
(Once Conda Package is Ready)
[](https://mybinder.org/v2/gh/jupyter-xeus/xeus-nelson/main?urlpath=/lab/tree/notebooks/xeus-nelson.ipynb)
## Documentation
To get started with using `xeus-nelson`, check out the full documentation
http://xeus-nelson.readthedocs.io
## Dependencies
`xeus-nelson` depends on
- [xeus-zmq](https://github.com/jupyter-xeus/xeus-zmq)
- [nlohmann_json](https://github.com/nlohmann/json)
- [nelson-core](https://github.com/Nelson-numerical-software/nelson-minimalist-core)
| `xeus-nelson` | `xeus-zmq` | `nlohmann_json` | `nelson-core` |
|---------------|----------------|-----------------|----------------|
| main | >=3.0,<4.0 | >=3.11.3 | >=0.3,<0.4 |
| 0.5.x | >=3.0,<4.0 | >=3.11.3 | >=0.3,<0.4 |
Prior vo version 0.2, `xeus-nelson` was also depending on [xtl](https://github.com/xtensor-stack/xtl) & [cppzmq](https://github.com/zeromq/cppzmq):
| `xeus-nelson` | `xeus-zmq` | `xtl` | `cppzmq` | `nlohmann_json` | `nelson-core` |
|---------------|------------------|-----------------|----------|-----------------|----------------|
| 0.4.x | >=1.0.0,<2.0 | >=0.7.0,<0.8 | ~4.4.1 | >=3.11.2 | >=0.3,<0.4 |
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a
development environment.
## License
This software is licensed under the GNU Lesser General Public License version 3. See the [LICENSE](LICENSE)
file for details.