.. highlight:: shell

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

Windows Prerequisites
---------------------

You will need to install python 3.7+ and the RAD Drivers for your probe to
work on Windows 10.

Python installation
~~~~~~~~~~~~~~~~~~~

It is preferable to download python from the website for install.

1. Go to you `python downloads page`_ and at least python 3.7 or later.

.. _python downloads page: https://www.python.org/downloads/

2. Run the installer, making sure to enable the `Add Python 3.X to path`
   this option shows up when you first start the installer see below.
   This will ensure you have the scripts installed on your local path

   .. image:: images/windows_python_installer.png
        :width: 400px
        :align: center

2. Using radicl on windows is best done through conda's terminal. If you dont have it, `download conda`_ and install it.

.. _download conda: https://www.anaconda.com/products/distribution

3. Check the install by opening up anacondas terminal and running:

   .. code-block:: console

    python --version

   Which should print out some thing like:

   .. code-block:: console

      >> Python 3.11.1


4. If everything works as expected, continue on to the drivers installation guide


RAD Drivers Install
~~~~~~~~~~~~~~~~~~~

**Windows will not automatically find drivers for the Lyte probe**. Follow the
instructions below to install them.

1. Download driver installation script from `Radicl on Github`_

.. _Radicl on Github: https://github.com/AdventureData/radicl/blob/master/scripts/driver_install.bat

2. Double click to launch the install in your downloads and follow the prompts.

If you have correctly installed the drivers move on to :ref:`Install radicl`.
below.


Linux - Ubuntu Prerequisites
----------------------------

* Python 3.7+
* TKinter

Installing TKinter on Ubuntu:

.. code-block:: console

  sudo apt-get install python3-tk


If you get permission denied in the
error when first using radicl you may need to add:

.. code-block:: console

  groups ${USER}
  sudo gpasswd --add ${USER} dialout

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

.. _Install radicl:
Install radicl
--------------

Installing radicl depends on your end use:
  1. Installing to only take measurements, Follow instruction to :ref:`Install radicl for Users Only`.
  2. Installing to develop radicl source code, Follow instructions to :ref:`Install radicl for Developers`.

.. _Install radicl for Users Only:
Install radicl for Users Only
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Install the latest stable release of radicl by running this command in your preferred terminal:

.. code-block:: console

    pip install radicl

2. Test the installation by, plugging in your probe to the computer, open a
   terminal or conda shell and run:

   .. code-block:: console

      radicl

   This should show some logging statements saying that your probe was found and
   present you with a question that says:

   .. code-block:: console

      What do you want to do with the probe? (daq, settings, update, help, exit)


**Once you have completed the setup, head over to** :ref:`Usage` **to see what
tools are available to you!**

.. _Install radicl for Developers:
Install radicl for Developers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The sources for radicl can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/AdventureData/radicl

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/AdventureData/radicl/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/AdventureData/radicl
.. _tarball: https://github.com/AdventureData/radicl/tarball/master