[Fix] refactoring and fixes

Author: blackwut

OUTFIT.zip

@@ -1,83 +1,50 @@
 # OUTFIT
 **OUTFIT - Dynamic Road Noise Maps Based on Crowdsourced Data and Represented in Digital Twins**
 
-The OUTFIT PRIN 2022 project aims to dynamically represent road traffic noise (RTN) in a Digital Twin (DT) model by optimizing the data flow related to noise levels and citizen perception.
+The **OUTFIT PRIN 2022** project aims to dynamically represent road traffic noise (RTN) in a **Digital Twin (DT)** model by optimizing the data flow related to noise levels and citizen perception.
+
 
 ## Overview
-This repository is dedicated to developing the pipeline that, starting from raw data obtained via API calls to the Google Maps Directions service, provides an output matrix of the perceived sound power at receivers located on building facades in the area of interest.
+This repository provides tools to:
+- Collect raw data via API calls to the **Google Maps Directions** service.
+- Process this data to generate **perceived sound power** at receivers located on building facades in the area of interest.
+
 
 # Installation
-The project needs the following package installed:
+## Requirements
+This project requires the following Python packages:
 - python-dotenv
 - requests
 - numpy
 - pyarrow
 - pandas
+- wxpython
+- pyinstaller
 
-We suggest to install them in a Python environment with `conda` (see [Miniconda Installation](#Miniconda-Installation)) or `venv` (see [Python Venv Installation](Python-Venv-Installation)).
+It is recommended to install these packages inside a Python virtual environment using **conda** or **venv**.
 
-## Miniconda Installation
-The following commands to install Miniconda3 on your system are taken from the [official documentation](https://docs.anaconda.com/miniconda/).
-### Windows CMD
-```bash
-curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe
-start /wait "" .\miniconda.exe /S
-del miniconda.exe
+You can find instructions to install Conda here: [Conda Installation](https://docs.conda.io/projects/conda/en/latest/user-guide/install/)
+You can find instructions to install venv (built into Python 3) here: [venv Documentation](https://docs.python.org/3/library/venv.html)
 
-# After installing, open the “Anaconda Powershell Prompt (miniconda3)” and
-# create a new environment from the environment.yml file
-conda env create -f environment.yml
-```
+Tip: You can use `pyenv.bat` (Windows) or `source pyenv.sh` (Linux/macOS) to automatically install Miniconda, set up the environment, and enter it.
+Alternatively, you can use `bundle.bat` (Windows, Linux/macOS support coming soon) to generate a standalone execution file for the entire project.
 
-### Windows PowerShell
-```bash
-curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe
-Start-Process -FilePath ".\miniconda.exe" -ArgumentList "/S" -Wait
-del miniconda.exe
 
-# After installing, open the “Anaconda Prompt (miniconda3)” and
-# create a new environment from the environment.yml file
-conda env create -f environment.yml
-```
+## Using Conda
+Once Conda is installed, create and activate a new environment with:
 
-### macOS
 ```bash
-mkdir -p ~/miniconda3
-curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh
-bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
-rm ~/miniconda3/miniconda.sh
-
-# Initialize miniconda for bash or zsh shells:
-~/miniconda3/bin/conda init bash
-# or
-~/miniconda3/bin/conda init zsh
-
-# Close and reopen your terminal to activate conda and
-# create a new environment from the environment.yml file
 conda env create -f environment.yml
+conda activate outfit
 ```
 
-### Linux
-```bash
-mkdir -p ~/miniconda3
-wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
-bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
-rm ~/miniconda3/miniconda.sh
-
-# Initialize miniconda for bash or zsh shells:
-~/miniconda3/bin/conda init bash
-# or
-~/miniconda3/bin/conda init zsh
-
-# Close and reopen your terminal to activate conda and
-# create a new environment from the environment.yml file
-conda env create -f environment.yml
-```
+This will automatically install all required packages defined in `environment.yml`.
 
-## Python Venv Installation
-The following commands to create a Python virtual environment are taken from the [official documentation](https://docs.python.org/3/library/venv.html).
 
-Before creating the virtual environment, make sure you have [cloned the repository](#clone-the-repository) and `cd` into it (e.g., `cd ~/OUTFIT`).
+## Using venv
+`venv` is a built-in Python module for creating isolated environments.
+Using a virtual environment ensures that your project dependencies do not conflict with other Python projects on your system.
+Steps to create a `venv`, install packages, and enter the environment:
 
 ### Windows CMD
 ```bash
@@ -98,4 +65,28 @@ pip install -r requirements.txt
 python -m venv outfit
 source outfit/bin/activate
 pip install -r requirements.txt
-```
+```
+
+# Usage
+You can run the project in two ways:
+
+1. **Download the executable**
+   Download the `OUTFIT.exe` file and run it directly.
+
+2. **Run with Python**
+   Install the required packages (see [Installation](#installation)) and run the GUI with:
+   ```bash
+   python src/outfit.py
+
+
+## Using the GUI
+Once the GUI appears, you will need to provide the following information:
+- `API Key`: your Google APIs key;
+- `Prefix`: a name to identify your collected data;
+- `data`: the path of the CSV file containing the streets for which data will be collected;
+- `Data Range`: the date and time range over which the data will be collected.
+- `Interval`: the time in minutes between two consecutive API calls while collecting street information.
+
+After filling in all the required fields:
+- Click `Start Schedule` to begin the data collection task.
+- Click `Remove Schedules` to delete all scheduled tasks.

README.md

@@ -1,3 +1,7 @@
+REM Author: Alberto Ottimo
+REM Project: OUTFIT
+REM Date: 2025-08-06
+
 @echo off
 setlocal
 
@@ -20,10 +24,10 @@ if exist "%CONDA_BAT%" (
     echo Miniconda already installed at %MINICONDA_PATH%
 ) else (
     echo Downloading Miniconda installer...
-    curl -L -o "%MINICONDA_INSTALLER%" "%MINICONDA_URL%"
+    curl -# -L -o "%MINICONDA_INSTALLER%" "%MINICONDA_URL%"
 
-    echo Installing Miniconda silently...
-    start /wait "" "%MINICONDA_INSTALLER%" /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /S /D="%MINICONDA_PATH%"
+    echo Installing Miniconda silently into %MINICONDA_PATH%...
+    start /wait "" Miniconda3-latest-Windows-x86_64.exe /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /S /D=%MINICONDA_PATH%
 
     echo Removing installer...
     del "%MINICONDA_INSTALLER%"
@@ -55,19 +59,22 @@ if %errorlevel%==0 (
     call "%CONDA_BAT%" env create -f environment.yml
 )
 
+REM === Activate ENV_NAME env  ===
+call "%CONDA_BAT%" activate "%ENV_NAME%"
+
 REM === Build executable with pyinstaller ===
-pyinstaller --onefile --name %EXENAME% --icon=%ICON% %SCRIPT_NAME%.py
+pyinstaller --onefile --name %EXENAME% --icon=%ICON% --noconsole %SCRIPT_NAME%
 if errorlevel 1 (
     echo [ERROR] PyInstaller failed to build executable.
     exit /b 1
 )
 
 REM === Move the .exe to the current directory ===
-move /Y "dist\%SCRIPT_NAME%.exe" . >nul
+move /Y "dist\%EXENAME%.exe" . >nul
 
 REM === Clean up unnecessary build files ===
 echo [*] Cleaning up intermediate files...
-del /Q /F "%SCRIPT_NAME%.spec" 2>nul
+del /Q /F "%EXENAME%.spec" 2>nul
 rmdir /S /Q build 2>nul
 rmdir /S /Q dist 2>nul
 rmdir /S /Q __pycache__ 2>nul

install.bat renamed to bundle.bat

@@ -1,11 +1,6 @@
 @echo off
 setlocal enabledelayedexpansion
 
-REM === CONFIGURATION ===
-set "SCRIPT_NAME=src\collect_data_gui.py"
-set "EXENAME=OUTFIT"
-set "ICON=icons\outfit_rounded.ico"
-
 REM === Set project-local Miniconda installation path ===
 set "PROJECT_DIR=%~dp0"
 set "MINICONDA_PATH=%PROJECT_DIR%Miniconda3"
@@ -20,10 +15,10 @@ if exist "%CONDA_BAT%" (
     echo Miniconda already installed at %MINICONDA_PATH%
 ) else (
     echo Downloading Miniconda installer...
-    curl -L -o "%MINICONDA_INSTALLER%" "%MINICONDA_URL%"
+    curl -# -L -o "%MINICONDA_INSTALLER%" "%MINICONDA_URL%"
 
-    echo Installing Miniconda silently...
-    start /wait "" "%MINICONDA_INSTALLER%" /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /S /D="%MINICONDA_PATH%"
+    echo Installing Miniconda silently into %MINICONDA_PATH%...
+    start /wait "" Miniconda3-latest-Windows-x86_64.exe /InstallationType=JustMe /RegisterPython=0 /AddToPath=0 /S /D=%MINICONDA_PATH%
 
     echo Removing installer...
     del "%MINICONDA_INSTALLER%"
@@ -55,6 +50,5 @@ if %errorlevel%==0 (
     call "%CONDA_BAT%" env create -f environment.yml
 )
 
-REM === Launch a new shell with the environment activated ===
-start cmd.exe /k "%MINICONDA_PATH%\Scripts\activate.bat %ENV_NAME%"
-exit /b
+REM === Activate environment in new shell ===
+start cmd.exe /k "%MINICONDA_PATH%\Scripts\activate.bat %ENV_NAME%"

python.bat renamed to pyenv.bat

@@ -2,16 +2,15 @@
 
 set -e  # Exit on any error
 
-# === CONFIG ===
+# CONFIG
 MINICONDA_DIR="$HOME/miniconda3"
 MINICONDA_INSTALLER="Miniconda3-latest-Linux-x86_64.sh"
 if [[ "$OSTYPE" == "darwin"* ]]; then
     MINICONDA_INSTALLER="Miniconda3-latest-MacOSX-x86_64.sh"
 fi
 MINICONDA_URL="https://repo.anaconda.com/miniconda/$MINICONDA_INSTALLER"
 
-# === FUNCTIONS ===
-
+# FUNCTIONS
 install_miniconda() {
     echo "Downloading Miniconda installer..."
     curl -L -o "$MINICONDA_INSTALLER" "$MINICONDA_URL"
@@ -23,7 +22,7 @@ install_miniconda() {
     rm "$MINICONDA_INSTALLER"
 }
 
-# === MAIN ===
+# MAIN
 
 # 1. Install Miniconda if needed
 if [ -x "$MINICONDA_DIR/bin/conda" ]; then
@@ -47,15 +46,15 @@ if [ -z "$ENV_NAME" ]; then
     exit 1
 fi
 
-# === Check if environment already exists ===
+# Check if environment already exists
 if conda info --envs | awk '{print $1}' | grep -q "^$ENV_NAME$"; then
     echo "Environment '$ENV_NAME' already exists. Skipping creation."
 else
     echo "Creating conda environment from environment.yml..."
     conda env create -f environment.yml
 fi
 
-# === Activate the environment ===
+# Activate the environment
 echo "Activating environment: $ENV_NAME"
 conda activate "$ENV_NAME"
 

install.sh renamed to pyenv.sh

@@ -18,7 +18,7 @@ def parse_args():
     """
     parser = argparse.ArgumentParser(description="Collect data using Google Directions API.")
     parser.add_argument('-i', '--input',  required=True,  help="Path to input CSV file.")
-    parser.add_argument('-o', '--output', required=False, help="Specify the directory to store the output CSV file.", default="")
+    parser.add_argument('-o', '--output', required=False, help="Specify the directory to store the output CSV file.", default=".")
     parser.add_argument('-p', '--prefix', required=True,  help="Prefix name of output CSV file.")
     return parser.parse_args()
 
@@ -83,27 +83,21 @@ def enrich_with_directions(api_key: str, df: pd.DataFrame, now: datetime) -> pd.
     return df
 
 def collect_data(
+        api_key: str,
         input_filepath: str,
         output_dirpath: str,
         prefix: str,
-        now: datetime
-        ):
+        now: datetime):
     if not os.path.isfile(input_filepath):
         logging.error(f"The input file does not exist: {input_filepath}")
-        sys.exit(1)
+        sys.exit(2)
 
     if not os.path.isdir(output_dirpath):
         logging.error(f"The output directory does not exist: {output_dirpath}")
-        sys.exit(2)
+        sys.exit(3)
 
     if not (prefix and prefix.strip()):
         logging.error(f'The prefix has not been specified.')
-        sys.exit(3)
-
-    env = EnvManager()
-    api_key = str(env.get(Env.API_KEY))
-    if not (api_key and api_key.strip()):
-        logging.error(f"The API_KEY is not set!")
         sys.exit(4)
 
     try:
@@ -115,7 +109,7 @@ def collect_data(
         write_csv_file(output_df, output_filename)
 
     except Exception as e:
-        logging.error("Fatal error occurred: {e}")
+        logging.error(f"Fatal error occurred: {e}")
         raise
 
 
@@ -124,4 +118,11 @@ def collect_data(
     setup_logging('collect', now)
 
     args = parse_args()
-    collect_data(args.input, args.output, args.prefix, now)
+
+    env = EnvManager()
+    api_key = str(env.get(Env.API_KEY))
+    if not (api_key and api_key.strip()):
+        logging.error(f"The API_KEY is not set!")
+        sys.exit(1)
+
+    collect_data(api_key, args.input, args.output, args.prefix, now)

src/collect_data.py

@@ -13,5 +13,5 @@
 PRINT_INFO = False
 DUMP_RESULTS = False
 
-SCHEDULE_PREFIX="outfit_"
+SCHEDULE_PREFIX="outfit"
 API_OUTPUT_DIRNAME = "api_output"