Installation

AutoOED can be installed either directly from the links to the executable files, or from source code. Source code is the most up-to-date version, while executable files are relatively stable.

Executable File

Personal Version

Follow the links below to install a zip file, unzip it and find the executable file at the corresponding location.

Installation Link Executable File Location
Windows AutoOED\AutoOED.exe
MacOS AutoOED.app
Linux AutoOED/AutoOED

Team Version

There are three executable files for different roles of the team: AutoOED_Manager, AutoOED_Scientist and AutoOED_Technician.

Before installing AutoOED, MySQL database management system needs to be installed on computers that will use AutoOED.

After installing MySQL, follow the links below to install a zip file, unzip it and find the executable file at the corresponding location.

Installation Link Executable File Location
Windows Manager AutoOED\AutoOED_Manager.exe
Windows Scientist AutoOED\AutoOED_Scientist.exe
Windows Technician AutoOED\AutoOED_Technician.exe
MacOS Manager AutoOED_Manager.app
MacOS Scientist AutoOED_Scientist.app
MacOS Technician AutoOED_Technician.app
Linux Manager AutoOED/AutoOED_Manager
Linux Scientist AutoOED/AutoOED_Scientist
Linux Technician AutoOED/AutoOED_Technician

Source Code

Clone the github repository at https://github.com/yunshengtian/AutoOED, then follow the instructions in README to install.

Extra Steps for Custom Evaluation Programs

There is some more work to do if you want to link your own evaluation programs to AutoOED to achieve fully automated experimentation, and the type of work depends on which language your program is written in (we currently support Python, C/C++ and MATLAB). Otherwise, if your evaluation cannot be executed by programs, you can skip this part.

Python

There is no extra installation step for Python evaluation programs. But you may pay attention to the packages imported into your evaluation program. If you install AutoOED directly from executable files, make sure the packages are in the dependencies of AutoOED (by checking environment.yml or requirements.txt); otherwise, if you install AutoOED from source code, you need to make sure the packages exist in your python environment already to avoid import errors.

C/C++

To use C/C++ evaluation programs in AutoOED, you need to make sure you have gcc (for C) or g++ (for C++) pre-installed on your computer. Otherwise, AutoOED will fail to compile your evaluation programs without proper compilers.

MATLAB

To use MATLAB evaluation programs in AutoOED, you need to install AutoOED from source code, and of course, have MATLAB pre-installed on your computer. Then, find the root folder of MATLAB. If you have trouble finding it, just start MATLAB and type matlabroot in the command window. Copy the path returned by matlabroot.

Next, you need to navigate to the folder:

  • matlabrootexternenginespython (for Windows)
  • matlabroot/extern/engines/python (for MacOS and Linux)

and execute python setup.py install. By doing so, MATLAB python extension is installed and AutoOED is able to automatically call MATLAB programs.