Installation¶
Vaxflux is a Python package and can be installed using pip, conda, or any other standard package managers. It is compatible with Python 3.11 and 3.12.
Install From PyPI¶
For most users, the recommended installation method is from PyPI:
Using pip¶
To install vaxflux using pip, run the following command in your terminal:
Using uv¶
To add vaxflux to your uv environment, you can use the following command:
Install The Development Version From GitHub¶
If you install directly from GitHub, you will get the development version of
vaxflux rather than the latest PyPI release.
For the development version, refer to the development documentation.
Optional Dependencies¶
The vaxflux package also provides two optional dependency groups:
plot: This adds additional dependencies that enable plotting functionality, without it you can still use the package to construct and fit models but will not be able to plot the results with built in functionality. It's recommended for local use that you include this optional dependency group, but it is not recommended for production usage (e.g. in an HPC environment).demo: This adds additional dependencies that are needed for running the jupyter notebooks in thedemos/directory. This optional dependency group is generally not needed unless you are learning the package and want to run those demos locally yourself.
To install these optional dependency groups from PyPI:
To install them from the GitHub development version: