|
2 | 2 | User Interfaces |
3 | 3 | =============== |
4 | 4 |
|
5 | | -Linux |
6 | | ------ |
| 5 | +Ipython |
| 6 | +------- |
7 | 7 |
|
8 | | -To run the python shell, just do it through the docker composition:: |
| 8 | +To run the ipython shell, just do it through the docker composition:: |
9 | 9 |
|
10 | 10 | docker-compose run app ipython |
11 | 11 |
|
12 | | - |
13 | | -MacOS or Windows |
14 | | ----------------- |
15 | | - |
16 | | -Same as in Linux, but you need to create a docker machine first:: |
17 | | - |
18 | | - docker-machine create --driver virtualbox --virtualbox-memory 8096 timeside |
19 | | - eval "$(docker-machine env timeside)" |
20 | | - docker-compose run app ipython |
21 | | - |
22 | | -More infos about the TimeSide docker image: https://registry.hub.docker.com/u/parisson/timeside/ |
23 | | - |
24 | | - |
25 | 12 | Notebook |
26 | 13 | --------- |
27 | 14 |
|
28 | 15 | You can also run your code in the wonderful `Jupyter Notebook <http://jupyter.org/>`_ which gives you a web interface to run your own code and share the results with your collaborators:: |
29 | 16 |
|
30 | | - docker-compose -f docker-compose.yml -f conf/dev.yml run --service-ports notebook |
31 | | - |
32 | | -and then browse http://localhost:8888 to acces the Jupyter notebook interface. |
33 | | - |
34 | | -On MacOS or Windows, you will need to ask the IP of the virtual machine to docker-machine:: |
35 | | - |
36 | | - docker-machine ip timeside |
| 17 | + docker-compose -f docker-compose.yml -f conf/notebook.yml up |
37 | 18 |
|
38 | | -If it gives you for example 192.168.59.103, you should be able to browse the notebook at http://192.168.59.103:8888/ |
| 19 | +and then browse http://localhost:8888 to access the Jupyter notebook interface. Use the token given in the docker logs of the `notebook` container to login. |
39 | 20 |
|
40 | 21 | .. warning :: Running a Jupyter notebook server with this setup in a non-secured network is not safe. See `Running a notebook server <http://jupyter-notebook.readthedocs.org/en/latest/public_server.html/>`_ for a documented solution to this security problem. |
41 | 22 |
|
42 | 23 |
|
43 | 24 | Use you own data |
44 | 25 | ---------------- |
45 | 26 |
|
46 | | -The var/media directory is mounted in /srv/media in the container so you can use it to exchange data between the host and the app container. |
| 27 | +The `var/media` directory is mounted in `/srv/media` inside the container so you can use it to exchange data between the host and the app container. |
47 | 28 |
|
48 | 29 |
|
49 | | -Web Server (experimental) |
50 | | -------------------------- |
| 30 | +Web Server |
| 31 | +---------- |
51 | 32 |
|
52 | 33 | TimeSide now includes an experimental web service with a REST API:: |
53 | 34 |
|
|
0 commit comments