Quick install

Install irfpy.aspera with PIP or UV

Normal users are recommended to install irfpy.aspera from the distribution server at https://irfpy.irf.se/simple/ .

With using PIP:

% pip install --index-url=https://irfpy.irf.se/simple/ irfpy.aspera --pre

With using UV:

% uv pip install --index-url=https://irfpy.irf.se/simple/ irfpy.aspera --pre

Note

irfpy.aspera is not published on the public PyPI, so always install from the internal server at https://irfpy.irf.se/simple/ . The --pre flag is recommended because new releases are published frequently.

Update irfpy.aspera

To update to the latest version:

% pip install --index-url=https://irfpy.irf.se/simple/ irfpy.aspera -U --pre
% uv pip install --index-url=https://irfpy.irf.se/simple/ irfpy.aspera -U --pre

Check installation

Verify that the package installed correctly:

% pip list | grep irfpy

Then try importing it:

import irfpy.aspera
print(irfpy.aspera.__version__)

Install from the source code

To develop irfpy.aspera library itself, install from the source checkout.

Note

Source code is managed locally at IRF, available upon request.

The simplest installation is to use uv, after checking out the source tree:

% uv sync

UV sync installs the irfpy.aspera package from the local source checkout in editable mode, so changes to the source are reflected without reinstalling. (Therefore, –pre is not needed for irfpy.aspera to be installed as editable mode.)