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

Create and activate a virtual environment

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

Install the dependencies

pip install '.[dev,docs]'

This will install dependencies, including pytorch and pytorch-geometric. For macOS, CPU version of pytorch will be installed, whereas for Linux, a GPU version targeting the latest CUDA release will be installed. Installation of alternate or older CUDA versions may be supported in the future.

To simplify testing for developers, we provide a Makefile, which allows you to run the above steps and test with one command:

make

There are additional Makefile targets to automate tasks:

• make test: runs testing framework
• make lint: runs pylint
• make format: autoformats code using ruff
• make ruff-checks: lints and checks that code is formatted using ruff

Note that the above commands will install development and documentation dependencies. If you are only using this library as a dependency, use:

pip install git+https://github.com/OxfordRSE/L2Gv2

For development, we highly recommend installing the pre-commit hook that helps lint and autoformat on every commit. To install pre-commit, run pre-commit install once in the repository; this will ensure that checks run before every commit.

License

This project is licensed under the MIT license.

Contributors

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

This project follows the all-contributors specification.