Setup and Installation

FASLR is in the early stages of development. As such, rapid implementation of features has been prioritized over the stability of the user experience (sorry). There are currently no binary executables available. People who are interested in seeing what FASLR can do as well as potential contributors will, for the time being, need to run FASLR from source.

Supported Operating Systems

FASLR is developed on Linux, specifically Ubuntu 22.04, which is probably what you want to use if you want to capture the same look and feel that you see in the documentation and in the development blog.

However, Python and Qt are cross-platform, which means that you may try it on other systems, but there are no guarantees on my end that it’ll work as well as it does on Linux.

Cloning the Repository

The first step in using FASLR is to clone the repository from the CAS GitHub. This can be done by opening a terminal, navigating to the directory where you want to keep the repo, and then running the command:

git clone https://github.com/casact/faslr

Installing Dependencies

I recommend that you use a virtual environment to avoid package conflicts.

The Python package dependencies is located in the requirements.txt file. These can be installed with the following command:

pip install -r requirements.txt

Running FASLR

Once the packages have been installed, you can run FASLR by executing the main.py file in the faslr directory:

python -m faslr

Alternatively, if you have a virtual environment set up:

source venv/bin/activate
python -m faslr

Demo files

In addition to the main program, you can test out individual widgets by running the files in the demos folder.