This document is a guide to use the the machine algorithms to predict serration and blade bevel using the following traits:
- General morhology of the kerf shape: Ellipse, D shape or Indeterminate
- Shape of the cross-profile (entrance and exit): V shape or Y shape
- Location of the rising profile (entrance and exit): single, bilateral or absent
- Presence or absence of feathering: present or absent
- Presence or absence of shards: present or absent
- Location (entrance, center and exit): single, bilateral or absent
- General morphology of the mounding: marked, not marked or absent
- Python 3
- JupyterLab (Jupyter Notebook not tested)
Before starting please download the .zip file at https://github.com/sciadi98/dissertation-steiger-2022/archive/refs/heads/main.zip and unzip it
Download Python at https://www.python.org/downloads/
How to install Python
- Run the installer
- Click "Install Now"
- Disable "Path length limit" > close
How to install the dependencies
- Double click on "install.bat file"
- The install of the dependecies could require several seconds, wait until the terminal closes itself
The installation steps must be executed only one time. If you move the main directory after the installation of the dependencies the app will stop working and it must be unistalled (delete main directory) and re install it
How to prepare the data
- Use the template provided in the main directory (dissertation_steiger_2022)
- The template can be filled with the following variables (see example in the template spreadsheet): E, D or I (shape); V or I/ (profile shape); single, bilateral or absent (rising); present or absent (shards); present or absent (feathering); single, bilateral or absent (mounding location); marked, not marked or absent (mounding general)
Warning
It's imperative to have the file excel in the main directory "dissertation_steiger_2022" otherwise it won't be loaded correctly.
How to run the app
- Go in the unzipped dissertation-steiger-2022-main directory
- Double click on "SFT_analysis.bat" file
- Follow the instructions on the terminal
Download Python at https://www.python.org/downloads/
How to install Python
- After accepting user agreement > Install > close
- Double click on install.certificates.cmd
- execute > close the terminal
How to install dependencies
- Right click "install.command" file > click open > click open > Open app
- Wait until the session is finished, then close the terminal (the process could take several seconds)
The installation steps must be executed only the first time. If you move the main directory after the installation of the dependencies the app will stop working and it must be unistalled (delete main directory) and re install it
How to prepare the dataset
- Use the template provided in the main directory
- The template can be fill with the following variables: E, D or I (shape); V or I/ (profile shape); single, bilateral or absent (rising); present or absent (shards); present or absent (feathering); single, bilateral or absent (mounding location); marked, not marked or absent (mounding general morphology)
Warning
It is imperative to have the file excel in the main directory "dissertation_steiger_2022" otherwise it won't be loaded correctly
How to run the app
- Go in the unzipped dissertation-steiger-2022-main directory
- Right click "SFT_analysis.command" file > open > open
- Follow the instructions on the terminal
$ sudo apt install python3
Python is already pre-installed on openSUSE, if not execute:
$ sudo zypper install python3
Python is already pre-installed on Fedora, if not execute :
$ sudo dnf install python3
$ sudo pacman -S python3
*How to install the dependencies"
- Open a terminal and execute "install.sh"
How to prepare the dataset
- Use the template provided in the main directory
- The template can be fill with the following variables: E, D or I (shape); V or I/ (profile shape); single, bilateral or absent (rising); present or absent (shards); present or absent (feathering); single, bilateral or absent (mounding location); marked, not marked or absent (mounding general morphology)
Warning
It is imperative to have the file excel in the main directory "dissertation_steiger_2022" otherwise it won't be loaded correctly
How to open app
- Open a terminal > execute "SFT_analysis"