Commit cf2c0bbb authored by Romulo Pereira Goncalves's avatar Romulo Pereira Goncalves
Browse files

Improve documentation

parent 01517cd3
......@@ -82,6 +82,33 @@ The message `The following object is masked from 'package:graphics':` means that
### Jupyter-lab
To start a `jupyter-lab` the user needs to set the variable `jupyter_lab` to `TRUE` in the `start_container.sh` script. Once set the user only needs to re-run the script and open in a web-browser the link `localhost:8080`. For more information on how to use jupyter_lab, please refer to its [manual](https://jupyterlab.readthedocs.io/en/stable/).
To start a `jupyter-lab` the user needs to set the variable `jupyter_lab` to `TRUE` in the `start_container.sh` script. Once set, the user only needs to re-run the script. The user will see the following output:
```bash
docker$ ./start_docker.sh
Error: No such container: hasa
Starting HaSa container, please add the input files to /home/romulo/gitlab/HabitatSampler/demo/Data and read the results from the /home/romulo/gitlab/HabitatSampler/demo/Data
[I 2021-01-29 13:58:46.420 ServerApp] jupyterlab | extension was successfully linked.
[I 2021-01-29 13:58:46.428 ServerApp] Writing notebook server cookie secret to /root/.local/share/jupyter/runtime/jupyter_cookie_secret
[I 2021-01-29 13:58:46.621 ServerApp] nbclassic | extension was successfully linked.
[I 2021-01-29 13:58:46.651 LabApp] JupyterLab extension loaded from /usr/local/lib/python3.8/dist-packages/jupyterlab
[I 2021-01-29 13:58:46.651 LabApp] JupyterLab application directory is /usr/local/share/jupyter/lab
[I 2021-01-29 13:58:46.654 ServerApp] jupyterlab | extension was successfully loaded.
[I 2021-01-29 13:58:46.658 ServerApp] nbclassic | extension was successfully loaded.
[I 2021-01-29 13:58:46.659 ServerApp] Serving notebooks from local directory: /home/hasa/demo
[I 2021-01-29 13:58:46.659 ServerApp] Jupyter Server 1.2.2 is running at:
[I 2021-01-29 13:58:46.659 ServerApp] http://a6d306398719:8888/lab?token=b883010687291bca935a65f39f40b66fc8a5a7646e866c1e
[I 2021-01-29 13:58:46.659 ServerApp] or http://127.0.0.1:8888/lab?token=b883010687291bca935a65f39f40b66fc8a5a7646e866c1e
[I 2021-01-29 13:58:46.659 ServerApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 2021-01-29 13:58:46.661 ServerApp]
To access the server, open this file in a browser:
file:///root/.local/share/jupyter/runtime/jpserver-12-open.html
Or copy and paste one of these URLs:
http://a6d306398719:8888/lab?token=b883010687291bca935a65f39f40b66fc8a5a7646e866c1e
or http://127.0.0.1:8888/lab?token=b883010687291bca935a65f39f40b66fc8a5a7646e866c1e
```
The user should then open one of the provided URLs in a web-browser. For more information on how to use jupyter_lab, please refer to its [manual](https://jupyterlab.readthedocs.io/en/stable/).
The `jupyter-lab` will open directly into the `demo/` directory of HaSa repository. The use should load the notebook `HabitatSamplerDocker.ipynb` to run the demo.
The `jupyter-lab` will open directly into the `demo/` directory of HaSa repository. The user should load the notebook `HabitatSamplerDocker.ipynb` to run the demo.
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