---
# System prepended metadata

title: Tool Installation Guide

---

# Tool Installation Guide


**Python Version Required** : 3.9.13 
**OS** : Linux

---
### A : First-Time Installation
---

**Following are the steps to run the Tool in the local system (For Linux)**
> 
> * Step 1 : Download the ZIP file from google drive.
> * Step 2 : Extract the ZIP file into a folder of choice.
> * Step 3 : Open a terminal in that folder. 
> * Step 4 : Create a virtual environment
```
pip install virtualenv
virtualenv v_env --python=python3.9
```
> * Step 5 : Activate the virtual environment
```
source v_env/bin/activate
```
> * Step 6 : Install the required python packages using the following command
```
pip install -r requirements.txt
```
> * Step 7 : Install Redis Queue in the system
```
sudo apt-get update
sudo apt-get install redis
```
```
mvn dependency:copy-dependencies -DoutputDirectory=./jars -f $(python3 -c 'import importlib; import pathlib; print(pathlib.Path(importlib.util.find_spec("sutime").origin).parent / "pom.xml")')
```


> * Step 8 : To run the Tool, run the following command in the terminal.
```
python app.py
```

> * Step 9 : The Tool needs to handle the async task of classifying the PDFS. For that, we are using the Redis queue. To start a worker **Open a new terminal**
> * Step 10 : Use the following command to initiate the worker in the newly opened terminal
```
rq worker
```

The Tool will be hosted on the local IP. Open the browser and go to http://127.0.0.1:9050/login

---
### B : Routine Steps to start the Tool
---
> * Step 1 : Open the code directory in the terminal
> * Step 2 : Activate the virtual environment using the following command:
```
source v_env/bin/activate
```
> * Step 3 : To run the Tool, run the following command in the terminal.
```
python app.py
```
> * Step 4 : To start a worker **Open a new terminal**
> * Step 5 : Use the following command to initiate the worker in the newly opened terminal
```
rq worker
```

The Tool will be hosted on the local IP. Open the browser and go to http://127.0.0.1:9050/login
