INSTALL.md

Instalation Guide

To begin, ensure you have Python 3.9 or above installed on your system.

1. Install the required dependencies:

   pip3 install -r requirements.txt

2. Run the program:

   python3 main.py

3. Optionally, run the program with a custom configuration:

   python3 main.py <path_to_config_file>
   
   Example:
   python3 main.py src/configs/default.ini

If you prefer to use Docker, you can run the program with the following commands:

sudo docker run -v <path_to_output_folder>:/ipcs/out -v <path_to_input_config_file>:/ipcs/configs/default.ini --rm -it mirzaim/ipcs:latest

# Or simply
sudo docker run -v ./out/:/ipcs/out --rm -it mirzaim/ipcs:latest

# For custom configuration
sudo docker run -v ./out/:/ipcs/out -v ./default.ini:/ipcs/configs/default.ini --rm -it mirzaim/ipcs:latest