.. _installation:

Installation
============

Python Version
--------------
:mod:`pimoscope` is tested on Python 2.7 and Python 3.

Dependencies
------------
:mod:`pimoscope` uses these packages from PyPI.  Each package will install its own dependencies, too.
     
* `knilb`_ provides an Agent for Knilb.
* `bottle`_ is the micro webapp framework.
* `automation-hat`_ works with the `AutomationHAT`_ from Pimoroni for use with  RaspberryPi.
* `explorer-hat`_ works with the `ExplorerHAT`_ from Pimoroni for use with RaspberryPi.

.. _knilb: https://pypi.org/project/knilb/
.. _bottle: https://bottlepy.org/docs/dev/
.. _automation-hat: https://github.com/pimoroni/automation-hat
.. _explorer-hat: https://github.com/pimoroni/explorer-hat
.. _Pimoroni: https://shop.pimoroni.com/
.. _AutomationHAT: https://shop.pimoroni.com/products/automation-hat
.. _ExplorerHAT: https://shop.pimoroni.com/products/explorer-hat

Installation
------------
.. warning:: :mod:`pimoscope` must be run on a RaspberryPi because it contains dependencies on the :mod:`Rpi.GPIO` package.

You can install :mod:`pimoscope` package from a wheel file using ``pip`` tool.  When creating the ``virtualenv`` on your RaspberryPi be sure to include ``-system-site-packages`` flag to avoid errors with smbus.

.. code-block:: bash

  pi@raspberrypi: $ mkdir try-pimo
  pi@raspberrypi: $ cd try-pimo  
  pi@raspberrypi:~/try-pimo $ virtualenv -system-site-packages venv
  pi@raspberrypi:~/try-pimo $ source venv/bin/activate
  (venv) pi@raspberrypi:~/try-pimo $ pip install pimo-0.1-py2-none-any.whl
  (venv) pi@raspberrypi:~/try-pimo $ pimo -h