Commit b114daee authored by Christian Rohlfing's avatar Christian Rohlfing

- updated readme

parent e918d169
......@@ -12,5 +12,24 @@ Visit the notebook [index.ipynb](index.ipynb) for a table of contents.
* Run the interactive notebooks directly with binder:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fgdet3-demos/37ca6903514505b8c69370c99494bf7a3783e955?filepath=index.ipynb)
* Clone this repository with git and open the notebooks locally on your PC with Jupyter ([Anaconda](https://www.anaconda.com/) is highly recommended for this).
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgit.rwth-aachen.de%2FIENT%2Fgdet3-demos/development-lab?urlpath=lab/tree/index.ipynb)
* Run the notebooks on your local machine:
* Install [Anaconda](https://www.anaconda.com/) (using pip is also possible, you have to install all the requirements listed in `environment.yml` and install the two `jupyter labextension ...` commands listed below).
* Download/`git clone` this repository to your local disk.
* It is highly recommended to run the GDET3 notebooks in an isolated environment. You can create a new environment called `gdet3lab` from the provided `environment.yml` by running `conda env create -f environment.yml` in the Anaconda prompt. This makes sure that all required packages are installed amd don't interfere with the packages in your base environment.
* Activate this environment with `conda activate gdet3lab`.
* Run two final commands in the Anaconda prompt (with activated `gdet3lab` environment):
```bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install jupyter-matplotlib
```
* Finally run JupyterLab `jupyter lab`. In your browser, JupyterLab should start. You can then open `index.ipynb` for an overview over all notebooks.
* You can deactivate the environment with `conda deactivate` (and switch back to it with `conda activate gdet3lab`).
## Contact
If you found a bug, please use the [issue tracker](https://git.rwth-aachen.de/IENT/gdet3-demos/issues).
In all other cases, please contact [Christian Rohlfing](http://www.ient.rwth-aachen.de/cms/c_rohlfing/).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment