Installation
------------

There are various methods to install ``sensingcluespy``. For any method, we recommend using a virtual environment when installing the library, such as pyenv or virtualenv.

The simplest method is to install ``sensingcluespy`` directly from pypi::

    pip install sensingcluespy


To download the source code and install the library::

    git clone https://github.com/SensingClues/sensingcluespy.git
    cd </parent_location_of_the_library/sensingcluespy/>
    pip install .
    pip install -r requirements.txt


Further, we recommend using ``jupytext`` when working with Jupyter notebooks. Install it like so::

    pip install jupytext


Finally, you should create a personal account for SensingClues using the Cluey Data Collector app,
which can be downloaded from the Google Playstore (not supported for iOS currently).
Also see `here <https://sensingclues.org/portal>`_.