After cloning this repository, run the following command to create the Docker image
```shell
cd favad
./build.sh /root/software/
```
Note that building the Docker image requires root permission on the local machine.
The parameter for the build.sh script is the installation path of the software stack inside the Docker image.
Additional optional parameters can be provided to automatically accept the GAP license agreement:
...
...
@@ -46,11 +53,13 @@ If these optional parameters are not specified, the build process will ask for t
## How to run the Docker image
Once the Docker image has been created, use the following command to shell into the container:
Once the Docker image has been created and the [Docker daemon is running](https://docs.docker.com/config/daemon/), you can shell into the container mounting a local folder where the output is stored using:
```shell
docker run -t-i--volume/local_folder/:/root/sample/output/ favad /bin/bash
docker run -t-i--volume$HOME/favad_output/:/root/sample/output/ favad /bin/bash
```
The ouput files generated inside the Docker container will be stored in the specified /local_folder/.
Using the previous command, the ouput files generated inside the Docker container will be stored in $HOME/faved_output/.
Please note that the content of this folder will be overwritten, if the folder is not empty.
At this point you can run the workflow for fingerprinting and visualizing defects on the sample dataset inside the Docker container:
...
...
@@ -76,7 +85,7 @@ By running the installer, you are accepting the [GAP license agreement](http://w
If you installed the software stack locally, you can run the workflow for fingerprinting and visualizing defects on the sample dataset using
```shell
cd ./sample
python3 FaVa.py -p ./parameters.txt
python3 FaVaD.py -p ./parameters.txt
```
Note however that you are required to change the paths in the parameter.txt file to match the current location of the files and software executables.
