===================
Installing Stream
===================

Manual clone
============

If you want to add custom functionality to the framework, you can clone the repository manually:

Prerequisites
-------------

* ``git``: for cloning the repository
* ``pip``: for installing the required packages
* ``python>=3.8``: for running the framework

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

Clone the repository

.. code-block:: sh

    git clone git@github.com:KULeuven-MICAS/stream.git

or 

.. code-block:: sh

    git clone https://github.com/KULeuven-MICAS/stream.git

Install requirements through pip. Alternatively, anaconda spec file is also provided.

.. code-block:: sh

    pip install -r requirements.txt

Once the dependencies are installed, Stream can be run through the main file. More details are provided in :doc:`getting-started`.