Getting Started¶

This is a short introduction to running the Virtual Warehouse program. After this tutorial, you should be able to start the application and load sample data.

You can run the application from pre-build package (recommended) or build it from source (good for further development).

Installation (pre-build)¶

First download the latest executable for your OS:

Unix (Linux / macOS)

virtual-warehouse_linux.tar.gz

Windows

virtual-warehouse_win.zip

Extract the archive (and enter directory):

Unix (Linux / macOS)

tar xvf virtual-warehouse_linux.tar.gz
cd "Virtual Warehouse"

Windows

Use some archive manager then enter the directory

Run the executable:

Unix (Linux / macOS)

./'Virtual Warehouse'

Windows

# Double-click "Virtual Warehouse.exe" or run in command line:
start "Virtual Warehouse.exe"

Warning

Windows: Application isn’t signed right now. That means that you might see window “Winows protected your PC” from Windows Defender SmartScreen. Just click on “More info” and then “Run anyway”.

Installation (from source)¶

Application requires Python 3 and following requirements:

PySide2==5.15.0
xlrd==2.0.1
Owlready2==0.30
rdflib
python-xlsxio
requests

It is recommended to use Makefile if possible. It installs all requirements (creating a separate virtual environment). There is Windows equivalent of Makefile in form of make.bat. Build the project using the following command:

Unix (Linux / macOS)

make install

Windows

# Install Python 3 (follow instructions at https://www.python.org)
# Following command creates virtual environment venv with all requirements
make.bat venv

It is recommended to use Makefile (make.bat) for running the application. Before running the application you have to build resources (Makefile/make.bat does that automatically). After that you can also run the application by running the main.py file in the root directory.

Using Makefile/make.bat as follows:

Unix (Linux / macOS)

make run

Windows

make.bat run

Example Usage¶

For start download sample data warehouse_no_1_v2.xlsx (more about data format: Input Description)

Run the application.
In the main menu click on: File > Open and select the downloaded file.
After short loading you should see a 2D map of a warehouse.

Then you can explore the sidebar with a description of locations, items or orders. You can also display heat map statistics. More about user interface and different functions at User Interface.