Getting Started

Follow these steps to set up the PULSE simulator on your machine.

System Requirements

Ensure your system meets the following specifications for optimal performance.

Component Minimum Requirement Recommended
OS Windows 10, macOS, Linux Windows 11 (64-bit)
Python Version 3.8 Version 3.10 or higher
RAM 8 GB 16 GB or higher
GPU Integrated Graphics NVIDIA RTX Series (for Ray Tracing acceleration)

Installation

Method 1: Installer (Recommended)

Download the latest Windows installer for a quick setup without valid Python environment.

Download Installer (v1.0)

Method 2: Run from Source (For Developers)

Clone the repository and install the dependencies if you want to modify the code.

git clone https://github.com/moussaart/pulse-simulator.git
cd pulse-simulator

Create a Virtual Environment (Recommended)

python -m venv venv
# Windows
venv\Scripts\activate
# macOS/Linux
source venv/bin/activate

Install Dependencies

pip install -r requirements.txt

First-Time Setup

Run the main application script to launch the GUI. The first launch might take a few seconds to initialize the graphics engine.

python run.py

Tip

If you encounter issues with `PyQt6` or `PyQtGraph`, try reinstalling them specifically using `pip install --force-reinstall pyqt6 pyqtgraph`.

Next Steps

Once the application is running, proceed to the User Interface section to learn about the dashboard.