.. SMA-REACT documentation getting started file, created by
   sphinx-quickstart on Wed Sep  4 13:23:33 2024.


Installation
============
SMA-REACT is available under the GNU general public license
on GitHub_

.. _GitHub: https://github.com/maestrolab/SMAREACTcleaned

Currently, we do not support pip installation.
Please download or clone the repository and type::

``python setup.py install``

Requirements
------------
SMA-REACT is compatible with Python 3.9 and is built
with pyqt5, version 5.15.10. 
Here is a complete list of dependencies:

   * deap_
   * matplotlib_
   * numpy_
   * pandas_
   * pyqt5_
   * scikit-learn_
   * scipy_

.. _deap: https://deap.readthedocs.io/en/master/
.. _numpy: https://numpy.org/
.. _matplotlib: https://matplotlib.org/
.. _pandas: https://pandas.pydata.org/
.. _pyqt5: https://www.riverbankcomputing.com/static/Docs/PyQt5/
.. _scikit-learn: https://scikit-learn.org/stable/
.. _scipy: https://scipy.org/


We recommend creating an anaconda virtual environment with the aforementioned
packages installed and running the code in Spyder.
A packaged executable for SMA-REACT is in development.