Installation

Contents

Installation#

Python#

Install OptiProfiler from PyPI:

pip install optiprofiler

You can also install OptiProfiler from conda-forge:

conda install conda-forge::optiprofiler

Note

OptiProfiler includes the S2MPJ problem library by default. Optional problem libraries include PyCUTEst and the SOLAR adapter. PyCUTEst requires a separate installation. SOLAR uses a slim runtime derived from bbopt/solar under LGPL-2.1; see the adapter README and runtime manifest for provenance.

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 can optionally set up MatCUTEst and SOLAR.

Note that the installation of MatCUTEst and the SOLAR MATLAB adapter is optional. During the setup process, you will be asked whether you want to install them. If the solar submodule is already populated, setup adds it to the MATLAB path automatically; passing install_solar=false skips it even when present. Please be aware that MatCUTEst is only supported on Linux systems and is not available on macOS or Windows. The SOLAR adapter builds a local C++ executable from the vendored slim SOLAR runtime when it is first used.

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', false, 'install_solar', true))

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

setup uninstall
Contents