Installation guide

How to install and run the software

In order to install Felon Finder and launch, multiple ways are possible.

Method 1 - Using the installer

Windows

FelonFinder_1.0.3_WIN_x64_setup.exe

Simply execute the setup and you will be able to open the software on the go.

Linux

Felon_Finder_1.0.3_LINUX_setup.deb

You can double click on the package with a GUI or use dpkg -i Felon-Finder.deb to unpack it and run it once it’s over.

Method 2 - conda environment + pip

1) First, create a conda environment with the adequate Python version.

Whether you operate under Windows or Linux, enter this command in your terminal :

$ conda create --name felon-finder python=3.12.2

Warning

If for some reason you feel lost at this first step, we strongly recommend installing Miniconda and getting started with this tutorial.

2) The next step is to activate your conda environment with the following command :

$ conda activate felon-finder

3) Now that the environment is set up, you can download and install the required packages with this single command line :

Linux

$ pip install -r https://raw.githubusercontent.com/AlexandreLayous/felon-finder/main/requirements_linux.txt

Windows

$ pip install -r https://raw.githubusercontent.com/AlexandreLayous/felon-finder/main/requirements_win.txt

4) Once the environement is activated and the requirements are installed, please install the felonfinder package with pip from your terminal :

Linux

$ pip install felonfinder

Windows

$ pip install felonfinder[windows]

Note

Windows operated computers need one more dependency to work with the tensorflow package.

5) You can now run Felon Finder by typing this command line in your terminal :

Linux

$ felon-finder

Windows

$ felon-finder-win

Warning

Unlike its pip package, the actual Felon Finder executable contains dashes in its name !

Note

Once this setup has been done for the first time, you shouldn’t have to do it again unless you delete your conda environment or the files needed.

You will just have to activate the conda environment every time before running the software.

Method 3 - conda environment + GitHub clone

Felon Finder is almost ready to launch once you clone the GitHub repository.

1) In order to clone the repo, you can proceed with the method of your choice. For instance, with SSH, you can type the next commands in your command-line terminal :

$ git clone git@github.com:AlexandreLayous/felon-finder.git
$ cd felon-finder

2) Create a conda environment with the adequate Python version.

Whether you operate under Windows or Linux, enter this command in your terminal :

$ conda create --name felon-finder python=3.12.2

Warning

If for some reason you feel lost at this first step, we strongly recommend installing Miniconda and getting started with this tutorial.

3) Activate your conda environment with the following command :

$ conda activate felon-finder

4) Install the required dependencies with the following command :

Linux

$ pip install -r requirements_linux.txt

Windows

$ pip install -r requirements_win.txt

5) You can then type the next command in your command-line terminal to run the software :

$ python FelonFinder.py

Note

Once this setup has been done for the first time, you shouldn’t have to do it again unless you delete your conda environment or the files needed.

You will just have to activate the conda environment every time before running the software.