RES is a wrapper system that enables analysts and researchers to easily create, package, and execute experiments that are generated using virtual machines.
The current version of RES supports VirtualBox machines.
- The system currently does not allow entry of custom VM commands. This feature is forthcoming.
RES has been tested on:
- Windows 10 (64-bit)
- Ubuntu 16.04 LTE (64-bit)
- Python 3.6 (64-bit)
- VirtualBox 6.1.6
- [Several Other Python packages] (see requirements.txt)
Clone the source and then cd into the directory:
git clone https://github.com/raistlinJ/res
cd res
Setup and activate the virtualenv container
python -m venv venv
venv\Scripts\activate
Install the res python dependencies
pip install -r requirements.txt
Install Python >= 3.5 (if you already have it, skip this step):
sudo apt-get install libreadline-gplv2-dev libncursesw5-dev libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev libbz2-dev
wget https://www.python.org/ftp/python/3.6.9/Python-3.6.9.tgz
tar zxvf Python-3.6.9.tgz
cd Python-3.6.9
./configure
make
sudo make install
Setup and activate the virtualenv container
python3 -m venv venv
Clone RES repo
git clone https://github.com/raistlinJ/res
cd res
Activate the venv and install python dependencides
source venv/bin/activate
pip3 install -r requirements.txt
To run the GUI, follow the steps in Run the GUI. To run the engine tests, follow the steps in Run Engine Tests.
Navigate to the folder where you downloaded res and activate the virtualenv container
cd res
source venv\bin\activate
venv\Scripts\activate
Start the GUI
python main.py
A sample RES file can be downloaded here. After downloading the file, right-click and select to Import the file.
A driver program is included that will demonstrate several of the functions provided by RES.
Download the Sample RES file from here and save it into the following directory
res/src/main/python/ExperimentData/samples/
Activate the virtualenv container
cd res
(Windows)
venv\Scripts\activate
(Linux)
source venv\bin\activate
Run the Engine Tests:
cd src/main/python/
python TestEngine.py
Please contribute!