Download WARPSimLab

How to Install and Run on Windows

Important: WARPSimLab is distributed as a ZIP file. You must extract it before running.

1. Download the ZIP file: Use the download button below to download WARPSimLab.
2. Extract the ZIP file: Right-click the downloaded ZIP file and select Extract All....
   This step is required. The program may not run correctly if you try to launch it directly from inside the ZIP file.
3. Open the extracted folder: Open the newly created folder, not the compressed ZIP archive.
4. Launch the program: Double-click WARPSimLab.exe.

Running the Source Code on Ubuntu

WARPSimLab can be run directly from Python source code on Ubuntu. These instructions download the source release, install the required Ubuntu components, and create an isolated Python virtual environment. The commands below are for version 4.2.2.

1. Download and extract WARPSimLab

Open a terminal, and create and change to the directory where you want to install WARPSimLab. For example:

mkdir -p ~/WARPSimLab

cd ~/WARPSimLab

wget https://github.com/hialanne/warpsimlab/archive/refs/tags/v4.2.2.tar.gz -O WARPSimLab-4.2.2.tar.gz

Alternatively, download the WARPSimLab 4.2.2 source archive using a web browser. The file will normally be saved in your Downloads directory. Move it into the WARPSimLab directory:

mv ~/Downloads/4.2.2.tar.gz ~/WARPSimLab/WARPSimLab-4.2.2.tar.gz

Extract the archive and enter the WARPSimLab source directory:

tar -xzf WARPSimLab-4.2.2.tar.gz
cd WARPSimLab-4.2.2

2. Install the Ubuntu prerequisites

Run:

sudo apt update
sudo apt install python3 python3-venv python3-pip python3-tk

3. Create and activate a virtual environment

python3 -m venv .venv
source .venv/bin/activate

After activation, the terminal prompt will normally begin with (.venv).

4. Install the Python dependencies

python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt

5. Run WARPSimLab

python3 WARPSimLab.py

Running WARPSimLab again later

The Ubuntu prerequisites, virtual environment, and Python dependencies normally need to be installed only once. To run WARPSimLab again:

cd ~/WARPSimLab/warpsimlab-4.2.2
source .venv/bin/activate
python WARPSimLab.py

Change the directory in the first command if you installed WARPSimLab somewhere other than ~/WARPSimLab.

When finished, you can leave the virtual environment by running:

deactivate

WARPSimLab source code is released under the MIT License.

Running the Source Code on macOS

WARPSimLab can be run directly from Python source code on macOS. These instructions download the source release, verify that a suitable version of Python is installed, and create an isolated Python virtual environment. The commands below are for version 4.2.2.

1. Check the installed Python version

Open Terminal and run:

python3 --version

WARPSimLab requires Python 3.10 or newer. If Python is not installed, or the installed version is older than Python 3.10, download and install a current Python 3 release from python.org.

After installing Python, close the Terminal.

2. Download and extract WARPSimLab

Download the current WARPSimLab source release:

WARPSimLab 4.2.2 source archive

The file will normally be saved in your Downloads directory. Extract the archive, then open the Terminal again and change to the extracted WARPSimLab directory. For example:

cd ~/Downloads/warpsimlab-4.2.2

3. Create and activate a virtual environment

python3 -m venv .venv
source .venv/bin/activate

After activation, the Terminal prompt will normally begin with (.venv).

4. Install the Python dependencies

python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt

5. Run WARPSimLab

python3 WARPSimLab.py

Running WARPSimLab again later

Python, the virtual environment, and the Python dependencies normally need to be installed only once. To run WARPSimLab again:

cd ~/Downloads/warpsimlab-4.2.2
source .venv/bin/activate
python3 WARPSimLab.py

Change the directory in the first command if you installed WARPSimLab somewhere other than your Downloads directory.

When finished, you can leave the virtual environment by running:

deactivate

WARPSimLab source code is released under the MIT License.