Update Installation and Testing authored by Kummer, Florian's avatar Kummer, Florian
...@@ -85,6 +85,40 @@ The native libraries should be in the following location ...@@ -85,6 +85,40 @@ The native libraries should be in the following location
## Installing Jupyter ## Installing Jupyter
In order to use BoSSS properly,
a working installation of **Jupyter** (aka. Jupiterlab, Jupyter-Notebkook, etc.) 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].
Since Mid-2020, [dootnet-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 an widely-used of-the-shelf solution
outweigh the disadvantages.
Provided that Python is already installed, one can install Jupyter by
```code
pip install jupyterlab
```
resp.
```code
pip3 install jupyterlab
```
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.
For a first install, only Python notebooks are available in Jupyter. The Support for C#,
resp. `dotnet-interactive` must be added.
## Notes on Third-party libraries ## Notes on Third-party libraries
... ...
......