<commit_before>
User Interfaces
===============

Ipython
-------

To run the ipython shell, just do it through the docker composition::

    docker-compose run app ipython

Notebook
---------

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::

    docker-compose -f docker-compose.yml -f conf/notebook.yml up

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.

.. 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.


Use you own data
----------------

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.


Web Server
----------

TimeSide now includes an experimental web service with a REST API::

    git clone https://github.com/Parisson/TimeSide.git
    cd TimeSide
    docker-compose up db

This will pull all needed images for running the server and then initialize the database. Leave the session with CTRL+C and then finally do::
<commit_msg>Correction in the path conf->env<commit_after>
User Interfaces
===============

Ipython
-------

To run the ipython shell, just do it through the docker composition::

    docker-compose run app ipython

Notebook
---------

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::

    docker-compose -f docker-compose.yml -f env/notebook.yml up

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.

.. 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.


Use you own data
----------------

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.


Web Server
----------

TimeSide now includes an experimental web service with a REST API::

    git clone https://github.com/Parisson/TimeSide.git
    cd TimeSide
    docker-compose up db

This will pull all needed images for running the server and then initialize the database. Leave the session with CTRL+C and then finally do::

{'fraction_non_alphanumeric': 0.09608540925266904, 'fraction_numerical': 0.0028469750889679717, 'mean_word_length': 3.4337539432176656, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 8, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4694795', 'n_tokens_mistral': 786, 'n_tokens_neox': 741, 'n_words': 374}