Installation¶

Install from PyPI¶

The latest released version of sdr can be installed from PyPI using pip.

$ python3 -m pip install sdr

Install from GitHub¶

The latest code on main can be installed using pip in this way. The main branch should be equivalent to the latest release on PyPI.

$ python3 -m pip install git+https://github.com/mhostetter/sdr.git

Or a pre-released branch (e.g. release/0.0.x) can be installed this way.

$ python3 -m pip install git+https://github.com/mhostetter/sdr.git@release/0.0.x

Editable install from local folder¶

To actively develop the library, it is beneficial to pip install the library in an editable fashion from a local folder. This allows changes in the current directory to be immediately seen upon the next import sdr.

Clone the repo wherever you’d like.

$ git clone https://github.com/mhostetter/sdr.git

Install the local folder using the -e or --editable flag.

$ python3 -m pip install -e sdr/

Install the dev dependencies¶

The development dependencies include packages for linting and unit testing. These dependencies are stored in requirements-dev.txt.

ruff == 0.1.4
pre-commit
pytest
pytest-cov[toml]
pytest-xdist
pytest-benchmark >= 4.0.0

Install the development dependencies by passing -r to pip install.

$ python3 -m pip install -r requirements-dev.txt