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

You can install the Fast-ER package directly from ``pip``:

.. code-block:: python

   pip install fast-er-link

Alternatively, you can install it from the `GitHub repository <https://github.com/jacobmorrier/fast-er>`_:

.. code-block:: python

   pip install git+https://github.com/jacobmorrier/fast-er.git#egg=fast-er
    
Technical Requirements
----------------------

The package's technical requirements are defined by its dependencies:

#. `CuPy <https://docs.cupy.dev/en/stable/install.html>`_
#. `Matplotlib <https://matplotlib.org/stable/install/index.html>`_
#. `NumPy <https://numpy.org/install/>`_
#. `Pandas <https://pandas.pydata.org/docs/getting_started/install.html>`_

.. warning::
    An NVIDIA CUDA GPU with a Compute Capability of 3.0 or higher is required.

.. tip::
   CUDA-enabled GPUs are available for free through `Google Colab <https://colab.research.google.com>`_.