POptUS / IBCDFO

Interpolation-Based Composite Derivative-Free Optimization
Other
7 stars 2 forks source link

IBCDFO

Interpolation-Based Composite Derivative-Free Optimization

GitHub Code style: black Coverage Status Continuous Integration

This page contains source code for interpolation-based optimization methods for composite derivative-free optimization.

Relevant references include:

Contributing to IBCDFO

Contributions are welcome in a variety of forms; please see CONTRIBUTING.

Installation & Updating

Note that this repository depends on one or more submodules. After cloning this repository, from within the clone please run

git submodule update --init --recursive

to fetch all files contained in the submodules. This must be done before attempting to use the code in the clone. Issuing the command git pull will update the repository, but not the submodules. To update the clone and all its submodules simultaneously, run

git pull --recurse-submodules.

The ibcdfo python package can be installed by setting up a terminal with the target python and pip pair and executing

> pushd ibcdfo_pypkg
> python setup.py sdist
> pip install dist/ibcdfo-<version>.tar.gz
> popd

where <version> can be determined by looking at the output of the sdist command. The installation can be partially tested by executing

> python
>>> import ibcdfo
>>> ibcdfo.__version__
<version>

where the output <version> should be identical to the value used during installation.

License

All code included in IBCDFO is open source, with the particular form of license contained in the top-level subdirectories. If such a subdirectory does not contain a LICENSE file, then it is automatically licensed as described in the otherwise encompassing IBCDFO LICENSE.

Resources

To seek support or report issues, e-mail:

Cite IBCDFO

  @misc{ibcdfo,
    author = {Jeffrey Larson and Matt Menickelly and Jared P. O'Neal and Stefan M. Wild},
    title  = {Interpolation-Based Composite Derivative-Free Optimization},
    url    = {https://github.com/POptUS/IBCDFO},
    year   = {2024},
  }

About IBCDFO

Part of POptUS: Practical Optimization Using Structure.

Copyright (c) 2023, The Regents of the University of California, through Lawrence Berkeley National Laboratory and UChicago Argonne LLC through Argonne National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.