Installing AIMBAT
AIMBAT is built on top of standard Python, combined
with a number of popular third party modules such as NumPy and
SciPy. It is available as a package from the
Python Package Index, and can therefore be
installed using Python's standard package manager,
pip.
However, as AIMBAT is a standalone application, we recommend installing it
using tools like uv or pipx instead1. Here we show how to
install and run AIMBAT using uv.
Running AIMBAT without installing
Running applications with uv is very simple. It manages all dependencies and
even installs a compatible Python version if needed. A very convenient feature
of using uv is that it can run applications without installing them:
$ # First check that uv is available:
$ uv self version
uv 0.10.6
$ # Next run AIMBAT using uv tool:
$ uv tool run aimbat --version
⠴ Resolving dependencies...
2.0.0
The initial run may take a while to download AIMBAT and its dependencies, but
once that is done subsequent runs will be much faster. uv tool run is such a
useful command that it has its own alias, uvx:
Running the development version
Running AIMBAT without installing it is particularly useful for trying out the latest development version:
$ uvx git+https://github.com/pysmo/aimbat --version
Updating https://github.com/pysmo/aimbat (HEAD)
⠇ Resolving dependencies...
⠦ Preparing packages... (66/69)
---> 100%
---> 100%
2.1.0.dev0
To clean up after yourself, you can remove the uv cache:
$ uv clean
Clearing cache at: /home/bob/.cache/uv
Cleaning [==================> ] 91%
Removed 26702 files (2.1GiB)
Installing locally
Permanent installation is just as easy. Just run uv tool install:
$ uv tool install aimbat
⠦ Resolving dependencies...
⠇ Preparing packages... (66/69)
+ aimbat==2.0.0
...
Installed 1 executable: aimbat
You can now run AIMBAT using the aimbat command directly:
Tip
If the above command fails (because your shell can't find the aimbat
command), you may need to add ~/.local/bin to your PATH. This can be
done automatically by running uv tool update-shell.
Upgrading or uninstalling is just as easy with uv tool upgrade and uv tool
uninstall:
$ uv tool upgrade aimbat
Nothing to upgrade
$ uv tool uninstall aimbat
Uninstalled 1 executable: aimbat
-
If you want to get really fancy you can also use tools like MISE-EN-PLACE, which use
uvorpipxunder the hood. ↩