Skip to content

Install

Currently, we recommend installing from distributed repositories such as GitHub. First, download a recent version of the repository as follows.

$ git clone https://github.com/dwgoon/sfa.git sfa

Now, you can install the SFA Python package from the cloned directory.

$ cd sfa
$ pip install .

If you want to easily update the most recent stable version of the package from the repository, install in editable mode.

$ pip install -e .

Now, running git pull origin main is enough to update the package from the repository.

If you do not have permission to the global site-packages directory, you can use the --user flag:

$ pip install --user .

Otherwise, you can also consider Python virtual environments.