Installation¶

Graphorge is available as a Python package which depends on Python libraries only. Installing within the scope of a virtual environment is recommended.

Requirements¶

Support is set by the main dependencies required by Graphorge: PyTorch and PyG. The stable version of Graphorge requires PyG 2.6.1 and PyTorch 2.4.1, which is compatible with Python 3.9-3.12 and a variety of hardware and operating systems, see PyTorch requirements. The following installation procedure was tested on Ubuntu 24.04 using Python 3.11, with both CPU and GPU (cuda).

Note

Graphorge may be compatible with more recent releases of PyTorch and PyG but this was not tested.

Most requirements will be automatically installed when installing Graphorge. However, PyTorch and PyG often require a manual installation. Installation instructions are detailed in PyTorch and PyG documentations. They are summarized here for convenience:

CUDA

    pip install torch==2.4.1 torchvision==0.19.1 torchaudio==2.4.1 --index-url https://download.pytorch.org/whl/cu124
    pip install torch-scatter -f https://data.pyg.org/whl/torch-2.4.1+cu124.html
    pip install torch-sparse -f https://data.pyg.org/whl/torch-2.4.1+cu124.html
    pip install torch_geometric==2.6.1 -f https://data.pyg.org/whl/torch-2.4.1+cu124.html

CPU

    pip install torch==2.4.1 torchvision==0.19.1 torchaudio==2.4.1 --index-url https://download.pytorch.org/whl/cpu
    pip install torch-scatter -f https://data.pyg.org/whl/torch-2.4.1+cpu.html
    pip install torch-sparse -f https://data.pyg.org/whl/torch-2.4.1+cpu.html
    pip install torch_geometric==2.6.1 -f https://data.pyg.org/whl/torch-2.4.1+cpu.html

Package manager¶

At the moment, the Graphorge package has not been uploaded to the Python Package Index (PyPI).

From source¶

To install Graphorge from source, clone the related GitHub repository:

    git clone git@github.com:bessagroup/graphorge.git

Then, pip install from the newly created directory (see pip documentation for details):

    pip install .

Or, without cloning permanently the repository:

    pip install git+https://github.com/bessagroup/graphorge.git

Note

Consider performing an editable install when contributing to Graphorge:

    pip install -e .