Installation¶

Frames2Py needs CPython 3.11 or newer and NumPy 2.4 or newer. The supported combinations of Python version, platform and free-threaded build are on Supported Python and platforms.

From PyPI¶

pip install frames2py

uv pip install frames2py
# or, in a uv project:
uv add frames2py

The package is pure Python (a py3-none-any wheel); no compiler is needed.

Optional extras¶

The core installs NumPy only. Everything that needs another library is an extra:

Name the extras in brackets, quoted so the shell leaves the brackets alone:

pip install "frames2py[hdf5]"
pip install "frames2py[recorder,viewer]"

import frames2py never imports an extra's library. A function that needs one raises ImportError naming the extra to install when it is called, not before.

On Linux, dv-processing's wheels load the system's libatomic.so.1, which minimal images leave out: on Debian or Ubuntu, apt install libatomic1. dv-processing publishes macOS wheels for macOS 15 and later only.

Check the installation¶

import frames2py

print(frames2py.__version__)

1.0.0

Then run the quickstart.

Development version and source¶

These are for trying unreleased changes and for working on Frames2Py; the releases above are what to depend on.

• The development version, main from the Git repository:

  pip install "frames2py @ git+https://github.com/siddiquifaras/frames2py"
  pip install "frames2py[hdf5] @ git+https://github.com/siddiquifaras/frames2py"
  

• A checkout, set up for development with every extra and the test tools (Testing, Contributing):

  git clone https://github.com/siddiquifaras/frames2py.git
  cd frames2py
  uv sync --all-extras
  

• A wheel built from a checkout, to install elsewhere:

  uv build          # the wheel and the sdist, in dist/
  pip install dist/frames2py-*-py3-none-any.whl