soogo

Surrogate-based 0-th Order Global Optimization for black-box problems.

Current functionality

Installation

Use PyPI to install this package:

pip install soogo

See other installation methods below.

Binaries

The binaries for the latest version are available at https://github.com/NREL/soogo/releases/latest. They can be installed through standard installation, e.g.,

using pip (https://pip.pypa.io/en/stable/cli/pip_install/):

pip install git+https://github.com/NREL/soogo.git#egg=soogo

From source

This package contains a pyproject.toml with the list of requirements and dependencies (More about pyproject.toml at https://packaging.python.org/en/latest/specifications/pyproject-toml/). With the source downloaded to your local machine, use pip install [soogo/source/directory].

For developers

This project is configured to use the package manager pdm. With pdm installed, run pdm install at the root of this repository to install the dependencies. The file pyproject.toml has the list of dependencies and configurations for the project.

Documentation

This project uses Sphinx to generate the documentation. The latest documentation is available at https://nrel.github.io/soogo. To generate the documentation locally, run make html in the docs directory. The homepage of the documentation will then be found at docs/_build/html/index.html.

Logging and Output

The disp parameter on optimizers is deprecated and ignored. Use Python's logging to control verbosity and progress output.

Example setup:

import logging

# Show info-level messages from soogo
logging.basicConfig(level=logging.INFO)

# Enable debug for a specific optimizer module
logging.getLogger("soogo.optimize.surrogate_optimization").setLevel(logging.DEBUG)

# Or enable debug for all soogo modules
logging.getLogger("soogo").setLevel(logging.DEBUG)

Guidance:

• Module loggers follow Python paths (e.g., soogo.optimize.gosac, soogo.optimize.fsapso).
• Iteration progress and timings log at INFO; deeper diagnostics at DEBUG; non-fatal issues at WARNING.
• Passing disp will emit a deprecation warning and have no effect.

Testing

This project uses pytest to run the tests. To run the tests, run pytest at the root of this repository. Run pytest --help to see the available options.

Contributing

Please, read the contributing guidelines before contributing to this project.

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.

NLR Software Record number: SWR-24-57