Installing AIMBAT

# run without installing
uvx git+https://github.com/pysmo/aimbat

# or install permanently
uv tool install git+https://github.com/pysmo/aimbat

AIMBAT runs in the terminal and is published on PyPI. A tool like uv or pipx is the easiest way to install it: it creates an isolated virtual environment and puts the aimbat command on PATH. The examples below use uv¹.

Running without installation

uv can run AIMBAT directly, without a permanent installation:

$ uvx aimbat --version
2.0.0

The first run downloads AIMBAT and its dependencies. Later runs use the cache and start immediately.

Running the development version

The same command works against the GitHub repository, to try the latest development version:

$ uvx git+https://github.com/pysmo/aimbat --version
2.1.0.dev0

Clear the download cache afterwards with:

uv cache clean

Installing permanently

To keep the aimbat command available in the shell:

$ uv tool install aimbat
Installed 1 executable: aimbat

$ aimbat
Usage: aimbat COMMAND
...

Upgrade or uninstall with:

uv tool upgrade aimbat
uv tool uninstall aimbat

Using AIMBAT as a library

To call the Python API from other code (see Recipes for the fundamentals), add AIMBAT as a project dependency rather than installing the command:

uv add aimbat

import aimbat

pysmo's installation guide covers the project setup this assumes (uv init, uv run, optional direnv); the same steps apply here.