Repository navigation
Releases
Visual Version Release
Outbreak Lab
Author: Kacper Potaczała
Basic Info
The Visual Version is more complicated but also more user-friendly. It has a visual interface made in Kivy, and all options, presets, and simulations are in one place—no need to change anything in the main.py file.
To use this version, you have to install all packages and make sure the Python version is correct.
Usage
To run this app, download the ZIP version of the code from this release or copy it using Git. When this is done, make sure you have all the required libraries installed.
By default, some values are set. You can check them in the Set Data menu option. These values are the same as those listed in the parameters section here
If you want to change values, just type a new value in the field and click Save at the bottom of the page.
If you want to switch to using a preset, click the Set Presets menu option, select the preset you want from the list, and then click Save and Back. If you want to know what the options refer to, check this
On the left side of the main menu, there are additional options listed in the parameters here
To run the simulation, click Start Simulation and wait for loading to finish.
You can cancel loading at any time if it takes too long.
When loading finishes, a new window will open, and you can return to the menu by closing it.
To understand how to interpret results, check this
Visualas and what they do
There are some visuals and buttons, so we will list them all:
- Main menu
- The label on the left indicates what preset is used. When "None" is active, then options from Set Data are used.
- Checkboxes under the label are additional options to simulate. For more info, refer to this
- Buttons on the right are different screens, each with different options:
- Loading
- The circle with a percentage is just a loading visualization of how much data was calculated
- Cancel Loading button stops loading and returns to the main screen
- Set data
- The number of options is too great to list—refer to this page
- Back button returns to the main screen without saving changes
- Save button saves changes and returns to the main screen
- Set Preset
- The label at the top indicates which preset is selected
- The spinner below lets you choose one of the presets listed here
- Back button returns to the main menu without saving changes
- Save button sets the preset to the selected one, but does not exit to the main menu—click Back to return
Cuda set info
When using CUDA, sometimes it cannot be detected on a computer. If this happens, a notification will be displayed and CUDA will be automatically disabled.
Requirements Visual
Here are some requirements:
The app was built on Python version 3.12.2 and will work on this version.
Versions before 3.6 will not work due to the use of f-strings in many places. Try to use versions between [3.10.0 – 3.13.0], but the best version is 3.12.2.
Kivy allows versions from [3.8 – 3.13], so these should work as well.
This app operates on Kivy version 2.3.1.
Libraries
Libraries that are needed for correct operation of the app:
- matplotlib
- pandas
- numpy
- cupy
- kivy
Installation
For matplotlib, pandas, and numpy, use:
- python -m pip install matplotlib pandas numpy
Using CUDA is more complicated. The app was created on CUDA 12.8, but you should check if you have CUDA and what version. To do this, run the command:
- nvidia-smi
Then install:
- python -m pip install cupy-cuda{version}x
where version is the version of your CUDA. For example, for CUDA 12.8:
- python -m pip install cupy-cuda12x
For kivy
- python -m pip install "kivy[base]"
Exe Release
Outbreak Lab
Author: Kacper Potaczała
Basic Info
The EXE Version is the best version you can choose because everything is handled, and no installation is needed other than CUDA tools locally. To know what to do, check here
To use this version, you have to download the ZIP with the EXE file or installer from this release
Usage
To run this app, download the ZIP OutbreakLab.zip from this release or OutbreakLabInstaller.exe
- If you download the ZIP, then unpack it. Do not move OutbreakLab.exe or modify the _internal folder, as it might cause the app to not work correctly. Then run OutbreakLab.exe.
- If you use the installer, then download and run it. Go through the installer wizard, and the app will be installed. Then run OutbreakLab.exe. Do not move it from the folder, and do not modify the _internal folder.
Then the visual app will show up. For the next steps, refer to [VisualVersion] (https://github.com/QG1414/OutbreakLab/tree/VisualVersion?tab=readme-ov-file#usage)
Visualas and what they do
Visuals are the same as for the Visual Version, and you can check them here
Cuda set info
When using CUDA, sometimes it cannot be detected on a computer. If this happens, a notification will be displayed and CUDA will be automatically disabled.
Additionally, clicking on Enable CUDA for the first time might cause a slight freeze because some dependencies that need to be installed dynamically will run.
Important info about this version
This app has no key publishing, so Windows may not want to run it. You can bypass this easily.
Also, because of that, antivirus software might scan the app before running and, in edge cases, even delete it. This is the only drawback of this version.
Also, the first time installing or launching the app may take longer due to dependency loading.
Requirements
For this app version, you don't need Python or any libraries—just run the installer or run the EXE from the ZIP, and everything should work.
The only exception is CUDA. If CUDA is not working, refer to this page
ConsoleVersion Release
Outbreak Lab
Author: Kacper Potaczała
Basic Info
The console version is the simplest version of this app and also not recommended to use because it lacks security measures for incorrect values. To use this version, you need these libraries and Python installed here
All of the parameters that can be changed are located in the main.py file from line 10 to line 38.
All preset names are listed here
Usage
To run this app, download the ZIP version of the code from this release or copy using Git. When this is done, make sure you have all the required libraries installed.
By default, the selected preset is COVID. For more info about presets, check here
If you want to switch to a different preset, modify line 60: PRESETS..value
If you don't want to use presets and want to insert your own values, then comment out line 60 and uncomment lines 53 and 54.
Then you can modify the values above, or leave them as they are, and run the code.
In the console, you should see info that the simulation started and how many steps are completed.
When loading finishes, a plot should be displayed showing the number of infected people and a pie chart showing how many times there has been an epidemic, or it ended, or is still going but it's not an epidemic (Stable). For more about this, read here
Name Changes
In the console version, some parameters have changed names and you should know which value is which. For the full list, check here
Here are all the changes:
- generation_size == Generation Size
- chance_to_meet_people == Chance to meet
- n == Days to simulate
- k == Number of simulations
- p == Chance to infect while meeting
- curing_time_min == Minimal number of days to lose sickness
- curing_time_max == Maximal number of days to lose sickness
- curing_prob == Chance to cure from sickness
- res_time_min == Minimal number of days to lose resistance to sickness
- res_time_max == Maximal number of days to lose resistance to sickness
- hygiene == Hygiene Modifier
- population_control == Population Control Modifier
- healthcare == Healthcare Modifier
- vaccines == Vaccines Created
- vaccines_params[VACCINES_PARAMS.POPULATION_VACCINATED] == Percentage of Population Vaccinated
- vaccines_params[VACCINES_PARAMS.DAY_OF_VACCINES] == Day of Vaccines Creation
Requirements
Here are some requirements:
The app was built on Python version 3.12.2 and will work on this version.
Versions before 3.6 will not work for sure because of f-strings used in many places. Try to use versions between [3.10.0 - 3.13.0], but the best version is 3.12.2.
Libraries
Libraries that are needed for correct operation of the app:
- matplotlib
- pandas
- numpy
- cupy
Installation
For matplotlib, pandas, and numpy, use:
python -m pip install matplotlib pandas numpy
Using CUDA is more complicated. The app was created on CUDA 12.8, but you should check if you have CUDA and what version. To do this, run the command:
nvidia-smi
Then install:
python -m pip install cupy-cuda{version}x
where version is the version of your CUDA. For example, for CUDA 12.8:
python -m pip install cupy-cuda12x