Getting Started

🇪🇸 Ver en español

This guide will help you set up and run the Building Signal Simulator on your system.

Prerequisites

Manual Setup

• Java JDK 1.8.0_131
• Apache Tomcat 9.0.89
• MS Access database
• Web browser with JavaScript enabled

Docker Setup

• Docker
• Docker Compose
• Web browser with JavaScript enabled

Installation

Option 1: Manual Setup (Windows University Environment)

1. Clone the repository:

   git clone https://github.com/jjaroztegi/BuildingSignalSimulator.git
   cd BuildingSignalSimulator
   

2. Run the build script:

   build_uni.bat
   

   This script handles:

   • Environment variables configuration
   • Java compilation
   • Deployment to Tomcat

3. Access the application at: http://localhost:8082/BuildingSignalSimulator

Option 2: Manual Setup (Linux/Mac Environment)

1. Clone the repository:

   git clone https://github.com/jjaroztegi/BuildingSignalSimulator.git
   cd BuildingSignalSimulator
   

2. Ensure Java and Tomcat are installed and JAVA_HOME is set

3. Modify the build.sh script to set the correct TOMCAT_WEBAPPS path

4. Make the build script executable and run it:

   chmod +x build.sh
   ./build.sh
   

   This script handles:

   • Java compilation
   • Compiling with Java 8 compatibility and migrating to Jakarta EE
   • Deployment to Tomcat

5. Access the application at: http://localhost:8080/BuildingSignalSimulator

Option 3: Docker Setup

1. Clone the repository:

   git clone https://github.com/jjaroztegi/BuildingSignalSimulator.git
   cd BuildingSignalSimulator
   

2. Build and start the container:

   docker compose up -d
   

3. Access the application at: http://localhost:1313/BuildingSignalSimulator

Quick Start Guide

1. Create a New Configuration

   • Navigate to the "Configuration" tab
   • Enter building details (name, number of floors, head-end level)
   • Click "Save Configuration"

2. Add Components

   • Go to the "Components" tab
   • Select component type (Cable Coaxial, Base de Toma, Derivador, Distribuidor)
   • Add required components for your setup

3. Run Simulation

   • Switch to the "Simulation" tab
   • Arrange components for each floor
   • Click "Calculate" to run the simulation

4. View Results

   • Check the "Results" tab
   • Review signal levels for each floor
   • Verify levels are within acceptable margins (color-coded)
   • Review total cost and optimization suggestions

Troubleshooting

Common Issues

1. Database Connection Issues

   • Verify MS Access database file location
   • Check database connection settings
   • Ensure proper JDBC driver is available

2. Tomcat Deployment Problems

   • Verify Tomcat version (must be 9.0.89)
   • Check Tomcat logs for errors
   • Ensure proper permissions on deployment directory

3. Build Script Errors

   • Verify Java version (must be 1.8.0_131)
   • Check JAVA_HOME environment variable
   • Ensure all required dependencies are available

Getting Help

If you encounter issues not covered here:

1. Check the Issues section
2. Review error logs in logs/ directory
3. Create a new issue with detailed information about the problem

Next Steps

• Read the Architecture guide to understand the system structure
• Review the API Reference for integration
• Check the Features documentation for detailed functionality