Getting started

Installation (stable version)

Installation from pypi

user@localhost:~$ pip install urgap

Installation from source

Download urgap using GitHub or the zip file:

GitHub version: Starting from your command line, the easiest way is to clone the GitHub repo.

user@localhost:~$ git clone https://github.com/urgap/urgap.git

ZIP version: Alternatively, download and extract the urgap zip file

Next, navigate into the urgap folder and install the requirements. Use virtualenv for maximum convenience. We recommend using uv for the installation, but pip can be used as well.

uv version

user@localhost:~$ cd urgap
# base version
user@localhost:~/urgap$ uv sync
# with doc dependencies
user@localhost:~/urgap$ uv sync --extra docs
# with all extras
user@localhost:~/urgap$ uv sync --all-extras

pip version

user@localhost:~$ cd urgap
# base version
user@localhost:~/urgap$ pip install .
# with doc dependencies
user@localhost:~/urgap$ uv sync ".[docs]"
# with all extras
user@localhost:~/urgap$ pip install ".[all]"