l2gv2 - Local2Global

Overview

Documentation

Full documentation available here

Setup

Supported Python Versions: 3.10, 3.11, 3.12 Supported Operating Systems: macOS, Linux

Clone the repository on your machine

git clone https://github.com/OxfordRSE/L2Gv2.git

Setup the virtual environment

1. Create and activate a virtual environment

   python3 -m venv .venv
   source .venv/bin/activate

2. Install the dependencies

   pip install . --find-links https://data.pyg.org/whl/torch-{version}%2Bcpu.html

   For the above, select 2.5.1 for macOS and 2.4.1 for Linux. Note that this installs CPU versions of the dependencies. To install GPU versions, consult the pytorch-geometric documentation for the appropriate repository links, or visit https://data.pyg.org/whl to see all possible torch/GPU supported versions.

3. To build docs and for tests install the corresponding optional dependency sets

   pip install '.[tests]'
   pip install '.[docs]'

4. To install the development dependencies

   pip install '.[dev]'

License

Contributors

The following people contributed to this project (emoji key).

This project follows the all-contributors specification.