Install HyperMapper

Using pip

We recommend installing HyperMapper with pip:

pip install hypermapper

Using Conda

Dependencies:

In general, the use of Conda is recommended because it provides user-friendly access to a wealth of packages from the scientific Python ecosystem. Conda is a good default choice in Linux and OSX. Tested and preferred install anaconda3-4.8.3, other versions of anaconda3 should just work.

If you don't have Conda

You can directly install Anaconda from here. For Linux, you can install with:

wget https://repo.anaconda.com/archive/Anaconda3-2020.02-Linux-x86_64.sh
bash Anaconda3-2020.02-Linux-x86_64.sh

For MacOSX, you can install with:

wget https://repo.anaconda.com/archive/Anaconda3-2020.02-MacOSX-x86_64.sh
bash Anaconda3-2020.02-Linux-x86_64.sh

Anaconda will request that you agree to the terms of service, choose a path for the installation, and ask whether you wish to initialize Anaconda. We recommend answering 'yes' to the initialization. Then reload the terminal for the changes to take effect:

bash

If you already have Anaconda

If you already have Anaconda, we recommend creating a new environment for HyperMapper. This can be done with:

conda create -n <env_name> anaconda python=3.7
conda activate <env_name>

Additional dependencies

HyperMapper also requires the GPy package. You can install GPy with:

conda install -c conda-forge gpy

Manually installing dependencies

If you prefer to install dependencies manually with pip, you can use:

pip install numpy
pip install matplotlib
pip install ply 
pip install jsonschema 
pip install pandas 
pip install sklearn 
pip install gpy
pip install pydoe

Install HyperMapper:

git clone https://github.com/luinardi/hypermapper.git
cd hypermapper
export HYPERMAPPER_HOME=/path/to/hypermapper

Note that:

if HYPERMAPPER_HOME is not set up then "." will be used. HYPERMAPPER_HOME is useful when calling HyperMapper from another software like it is usual in Client-Server mode.

Using HyperMapper

Add the scripts directory to your PYTHONPATH to be able to import HyperMapper's modules. This can be done in your terminal with:

export PYTHONPATH=$PYTHONPATH:/path/to/hypermapper/scripts

Or in Python during runtime with:

import sys
sys.path.append('scripts')

Note that updating the PYTHONPATH during runtime will cause the changes to be reverted after execution.

Optional Dependencies:

These dependencies are not needed unless you are an advanced user.

pygmo This dependence is only needed for the plot_hvi.py script that enables to compare two Paretos using the HVI metric, see here for more info. You can find more info here: https://esa.github.io/pagmo2/install.html. WARNING: the python package pygmo crashes with anaconda3-5.0.0 while it works for anaconda3-4.4.0, this bug is unreported on the web and I found it after hours of exploration. anaconda3-5.0.0 only worked once, that was on Ubuntu 14.04.5 LTS.

Quick install on Linux and OSX:
```
conda config --add channels conda-forge
conda install pygmo
```
You can check that pygmo is installed by typing:
```
conda list | grep -i pygmo
```
Output should be something like:
```
pygmo     2.6     np113py36_1     conda-forge
```
Then you can check the import in python, if the import fails it is just because you have multiple versions of python and you are using the wrong version, i.e. the one that doesn't have pygmo installed, or because you are using a version of anaconda that crashes when loading the module, e.g. anaconda3-5.0.0:
```
python
from pygmo import *
```