Quick install¶
Install irfpy.util with PIP or UV¶
Normal users are recommended to install irfpy.util from the distribution server
at https://irfpy.irf.se/simple/ .
With using PIP:
% pip install --index-url=https://irfpy.irf.se/simple/ irfpy.util --pre
With using UV:
% uv pip install --index-url=https://irfpy.irf.se/simple/ irfpy.util --pre
Note
irfpy.util 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.util¶
To update to the latest version:
% pip install --index-url=https://irfpy.irf.se/simple/ irfpy.util -U --pre
% uv pip install --index-url=https://irfpy.irf.se/simple/ irfpy.util -U --pre
Check installation¶
Verify that the package installed correctly:
% pip list | grep irfpy
Then try importing it:
import irfpy.util
print(irfpy.util.__version__)
from irflab import *
Note
irflab is a convenience module that exports commonly used functions.
from irflab import * brings them into the current sessions.
This is particularly useful for interactive sessions.
Install from the source code¶
To develop irfpy.util 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.util 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.util to be installed as editable mode.)