Introduction
============

Radiens supports Python 3.10 and newer. 

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

Install the most recent Radiens version using pip:

.. code-block:: console

    $ pip install radiens

If you're looking to update an already installed version of Radiens to the newest version, run the following:

.. code-block:: console

    $ pip install --upgrade radiens

Basic Usage
-----------
Radiens currently provides two clients ``AllegoClient`` and ``VidereClient`` that can be used to interact with their respective servers `ALLEGO` and `VIDERE`. 

First, start the ALLEGO app. Then you can access it in python like this

.. code-block:: python

    >>> from radiens import AllegoClient

    >>> client = AllegoClient()
    >>> stat = client.get_status()
    >>> stat.sample_freq
    20000.0
    

For VIDERE, first start the app. Access the client in python like this 

.. code-block:: python

    from radiens import VidereClient

    client = VidereClient()