===============
Getting Started
===============

.. _system-requirements:

System Requirements
-------------------

ImputeGAP is compatible with Python>=3.10 (except 3.13) and Unix-compatible environment.

.. _installation:

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


To install the latest version of ImputeGAP from PyPI, run the following command:

.. code-block:: bash

    pip install imputegap

Alternatively, you can install the library from source:

.. code-block:: bash

    git init
    git clone https://github.com/eXascaleInfolab/ImputeGAP
    cd ./ImputeGAP
    pip install -e .



Troubleshooting
---------------
If you face any problems, please open an issue here: https://github.com/eXascaleInfolab/ImputeGAP/issues



Citing
------

If you use ImputeGAP in your research, please cite the library

.. code-block:: bash

    @software{ImputeGAP_2025,
        author = {Nater, Quentin and Khayati, Mourad},
        license = {MIT},
        title = {{ImputeGAP Library}},
        url = {https://github.com/eXascaleInfolab/ImputeGAP},
        year = {2025}
    }