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

We use uv for Python package management. You can install it on macOS or Linux using brew install uv. Alternatively, you can use uv's installation script.

nox simplifies Python testing, particularly across multiple Python versions. We provide a noxfile.py, which allows you to run tests and perform linting with one command. You'll first need to install nox:

brew install nox      # macOS
pipx install nox      # with pipx
sudo apt install nox  # debian
sudo dnf install nox  # fedora
uv tool install nox   # with uv

To run the tests and linting with pylint and ruff:

nox

To display a list of tasks:

nox --list

To run only a task, such as lint, run nox -s lint.

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:

brew install pre-commit     # macOS
pipx install pre-commit     # with pipx
sudo apt install pre-commit # debian
sudo dnf install pre-commit # fedora
uv tool install pre-commit  # with uv

To setup pre-commit hooks, 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.