Installation

Contents

Installation#

Python#

Install OptiProfiler via pip:

pip install optiprofiler

Note

OptiProfiler includes the S2MPJ problem library by default. If you also want to use the PyCUTEst problem library (available on Linux and macOS only), please follow the PyCUTEst installation guide.

MATLAB#

  1. Clone the repository using the following command:

git clone https://github.com/optiprofiler/optiprofiler.git

  1. In MATLAB, navigate to the root directory of this repository, where you can see a file named setup.m. Run the following command in the MATLAB command window:

setup

The setup function performs the following tasks:

  • Adds the necessary directories to the MATLAB search path.

  • Clones the default problem libraries, including S2MPJ and MatCUTEst.

Note that the installation of MatCUTEst is optional. During the setup process, you will be asked whether you want to install it. Please be aware that MatCUTEst is only supported on Linux systems and is not available on macOS or Windows.

For automated environments (e.g., CI/CD scripts) where interactive input is not possible, you can bypass the prompt by providing an additional option to the setup function:

setup(struct('install_matcutest', true))  % Or false if you do not need MatCUTEst

  1. If you want to uninstall the package, you can run:

setup uninstall
Contents