Update Installation and Testing authored by Kummer, Florian's avatar Kummer, Florian
......@@ -66,35 +66,44 @@ to verify that the installation works and the native libraries are in place. Fur
In order to use BoSSS properly, a working installation of [**Jupyter**](https://jupyter.org/) (aka. Jupiterlab, Jupyter-Notebkook, etc.) **with support for** [**dotnet-interactive**](https://github.com/dotnet/interactive) is required. Prior to the migration to .NET5, BoSSS used its own custom notebook format (`bws`, for BoSSS work sheet) and featured a notebook/worksheet editor embedded in [BoSSSpad](/bosss1/experimental/-/wikis/Getting-Started/BoSSSpad). Since Mid-2020, [dotnet-interactive](https://github.com/dotnet/interactive) is supported by Jupyter and reached a level of maturity so that it can replace the custom BoSSSpad solution. Although a dependency on an additional software component is a drawback (e.g. the user has to install and configure it) the advantages of a widely-used of-the-shelf solution with a large user-basis such as Jupyter outweigh the disadvantages.
Provided that Python is already installed, one can install Jupyter by
1. Ensure that a recent Python 3 distribution is installed on your system
- On Linux, one typically wants to use the package which ships with the
Linux distribution (e.g. `sudo apt-get install python3` on
[Debian](https://www.debian.org/) and derivatives like [Ubuntu](https://ubuntu.com/)
- For Windows, a a [Python 3 Installer](https://www.python.org/downloads/windows/)
is available.
- An alternative to the manual installation is the use of
the semi-commercial
[Anaconda Python distribution] (https://www.anaconda.com/products/individual);
(This saves the next step, since Anaconda already ships with Jupyter).
2. Provided that Python is already installed, one can install Jupyter by
```plaintext
pip install jupyterlab
```
resp.
```plaintext
pip3 install jupyterlab
```
probably best as `root` or with administrator rights.
This works in similar for Linux and Windows.
probably best as `root` or with administrator rights. This works in similar for Linux and Windows.
* Further details can be found in the [Original Documentation](https://jupyter.org/install).
* An alternative to the manual installation is the use of the semi-commercial [Anaconda Python distribution](https://www.anaconda.com/products/individual)
Once Jupyter is installed, it can be started/tested by launching a web browser (e.g. Firefox) and running either `jupyter-lab` or `jupyter-notebook` from a terminal. The GUI should then open in the browser.
Further details can be found in the [Original Documentation](https://jupyter.org/install).
For a first install, only Python notebooks are available in Jupyter. The Support for C#, resp. `dotnet-interactive` must be added. (See also in the [Original Documentation](https://github.com/dotnet/interactive/blob/main/docs/NotebooksLocalExperience.md).)
Once Jupyter is installed, it can be started/tested by launching a web browser (e.g. Firefox)
and running either `jupyter-lab` or `jupyter-notebook` from a terminal. The GUI should then
open in the browser.
1. The available kernels can be listed by `jupyter kernelspec list` in a python-aware terminal, e.g. Anaconda Prompt:
For a first install, only Python notebooks are available in Jupyter. The Support for C#,
resp. `dotnet-interactive` must be added. (See also in the
[Original Documentation](https://github.com/dotnet/interactive/blob/main/docs/NotebooksLocalExperience.md).)
3. The available kernels can be listed by `jupyter kernelspec list` in a python-aware terminal, e.g. Anaconda Prompt:
```plaintext
flori@Stormbreaker:~$ jupyter kernelspec list
Available kernels:
python3 /usr/local/share/jupyter/kernels/python3
```
2. Next, as non-elevated user (**not** `root`), `dotnet interactive` must be installed. Preferably (?) the [latest release](https://www.nuget.org/packages/Microsoft.dotnet-interactive/) via:
4. Next, as non-elevated user (**not** `root`), `dotnet interactive` must be installed. Preferably (?) the [latest release](https://www.nuget.org/packages/Microsoft.dotnet-interactive/) via:
```plaintext
dotnet tool install --global Microsoft.dotnet-interactive
......@@ -112,12 +121,12 @@ For a first install, only Python notebooks are available in Jupyter. The Support
export PATH=$PATH:/home/xxxxxxx/.dotnet/tools
export DOTNET_ROOT=/home/xxxxxxx/dotnet-sdk-5.0.301/
```
3. Then, as non-elevated user (**not** `root`), install the Jupyter kernel:
5. Then, as non-elevated user (**not** `root`), install the Jupyter kernel:
```plaintext
dotnet interactive jupyter install
```
4. Verify that Jupyter supports C#:
6. Verify that Jupyter supports C#:
```plaintext
flori@Stormbreaker:~$ jupyter kernelspec list
......
......