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

Retentioneering can be installed via pip using `PyPI <https://pypi.org/project/retentioneering/>`_.

.. code-block:: python

    pip install retentioneering

Or directly from Jupyter notebook or `google.colab <https://colab.research.google.com/>`_.

.. code-block:: ipython

    !pip install retentioneering


Python versions support
=======================

Officially Python 3.9, 3.10, 3.11, and 3.12.



Supported environments for visual tools
=======================================

To ensure the best performance when using our visual tools, we recommend running them with the following configuration:

- Environments

  - Jupyter Notebook

  - JupyterLab

  - JupyterHub

  - Google Colab

- Browsers

  - Google Chrome

  - Safari

  - Firefox


Upgrade
=======

From command line

.. code-block:: bash

    pip install --upgrade retentioneering

Directly from Jupyter notebook

.. code-block:: ipython

    !pip install --upgrade retentioneering