|
1 | | -[](https://github.com/scijava/scijava-jupyter-kernel/actions/workflows/build-main.yml) |
2 | | - |
3 | 1 | # scijava-jupyter-kernel |
4 | | -[](https://travis-ci.org/scijava/scijava-jupyter-kernel) |
| 2 | + |
5 | 3 | [](https://github.com/scijava/scijava-jupyter-kernel/blob/master/LICENSE) |
6 | 4 | [](https://anaconda.org/conda-forge/scijava-jupyter-kernel) |
7 | 5 | [](https://anaconda.org/conda-forge/scijava-jupyter-kernel) |
8 | 6 | [](https://mybinder.org/v2/gh/scijava/scijava-jupyter-kernel/master) |
9 | 7 | --- |
10 | 8 |
|
11 | | -`scijava-jupyter-kernel` aims to be a polyglot [Jupyter](http://jupyter.org/) kernel. It uses the [Scijava scripting languages](https://imagej.net/Scripting#Supported_languages) to execute the code in Jupyter client and it's possible to use different languages in the same notebook. |
12 | | - |
13 | | -Some of the supported languages are Groovy (default), Python, Beanshell, Clojure, Javascript, Ruby and Scala. |
14 | | - |
15 | | -The kernel has been originally created to work with ImageJ. See [here](https://imagej.net/Scijava_Jupyter_Kernel) for more details. |
16 | | - |
17 | | -*Under the hood `scijava-jupyter-kernel` uses the [Beaker base kernel](https://github.com/twosigma/beakerx/tree/master/kernel/base).* |
18 | | - |
19 | | -## Binder Usage |
20 | | - |
21 | | -- [ImageJ notebook](https://mybinder.org/v2/gh/4QuantOSS/scijava-jupyter-kernel/master?filepath=notebooks%2FImageJ.ipynb) |
22 | | -- [JupyterLab](https://mybinder.org/v2/gh/4QuantOSS/scijava-jupyter-kernel/master?urlpath=lab) |
23 | | - |
24 | | -## Documentation |
25 | | - |
26 | | -A documentation is available as a series of notebooks [here](./notebooks/Welcome.ipynb). |
27 | | - |
28 | | -## Installation |
29 | | - |
30 | | -- Install [Anaconda](https://www.continuum.io/downloads) |
31 | | -- Install `scijava-jupyter-kernel` with : |
32 | | - |
33 | | -```bash |
34 | | -# Add the conda-forge channel |
35 | | -conda config --add channels conda-forge |
36 | | - |
37 | | -# Create an isolated environment called `java_env` and install the kernel |
38 | | -conda create --name java_env scijava-jupyter-kernel |
39 | | -``` |
40 | | - |
41 | | -- Usage : |
42 | | - |
43 | | -```bash |
44 | | -# Activate the `java_env` environment |
45 | | -source activate java_env |
46 | | - |
47 | | -# Check the kernel has been installed |
48 | | -jupyter kernelspec list |
49 | | - |
50 | | -# Launch your favorite Jupyter client |
51 | | -jupyter notebook |
52 | | - |
53 | | -# or |
54 | | -jupyter lab |
55 | | -``` |
56 | | - |
57 | | -*Note : It is strongly suggested to install the kernel in an isolated Conda environment (not in the root environment).* |
58 | | - |
59 | | -## Development |
60 | | - |
61 | | -- [CI with Travis](https://travis-ci.org/scijava/scijava-jupyter-kernel) makes sure the project builds without errors for each new commit. |
62 | | -- A [test notebook](./notebooks/Test.ipynb) is executed during CI with [nbconvert](http://nbconvert.readthedocs.io/en/latest/execute_api.html). |
63 | | -- A [Conda package](https://github.com/conda-forge/scijava-jupyter-kernel-feedstock) is built for each new release. |
64 | | - |
65 | | -## License |
66 | | - |
67 | | -Under Apache 2.0 license. See [LICENSE](LICENSE). |
68 | | - |
69 | | -## Authors |
| 9 | +**THIS PROJECT HAS BEEN RETIRED. FOR ALTERNATIVES, PLEASE SEE:** |
70 | 10 |
|
71 | | -- Hadrien Mary <hadrien.mary@gmail.com> |
| 11 | +* [IJava](https://github.com/SpencerPark/IJava) for a Java kernel built on JShell. |
| 12 | +* [BeakerX](http://beakerx.com/) for several JVM dialects including Groovy, Scala, Clojure, Kotlin, Java, and SQL. |
0 commit comments