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

Prerequisites
-------------
Before installing **scDynOmics**, please ensure your system meets the following requirements:

* **Python:** Version 3.11 or newer is required.
* **Hardware:** At least one GPU is recommended for running the test module.

Install from Source
-------------------
Currently, the package is available via GitHub. You can install it directly from the source repository using `git` and `pip`:

.. code-block:: bash

    git clone https://github.com/KlughammerLab/scDynOmics.git
    cd scDynOmics
    pip install .

This command will automatically resolve and install all required core dependencies.

Verifying the Installation
--------------------------
To ensure the package and its environment are set up correctly on your GPU, you can run the built-in environment test at `scripts/test.py`:

.. code-block:: bash

    python scripts/test.py --data_dir data/ --log_dir logs/