Metadata-Version: 2.4
Name: ibcdfo
Version: 0.1.0
Summary: Interpolation-Based Composite Derivative-Free Optimization
Author-email: Jeffrey Larson <jmlarson@anl.gov>, Matt Menickelly <mmenickelly@anl.gov>, "Stefan M. Wild" <wild@lbl.gov>
Maintainer-email: Jeffrey Larson <jmlarson@anl.gov>, Matt Menickelly <mmenickelly@anl.gov>
License-Expression: MIT
Project-URL: Repository, https://github.com/POptUS/IBCDFO
Project-URL: Documentation, https://ibcdfo.readthedocs.io
Project-URL: Issues, https://github.com/POptUS/IBCDFO/issues
Keywords: ibcdfo
Classifier: Natural Language :: English
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.22.0
Requires-Dist: scipy>=1.8.0
Requires-Dist: ipdb
Requires-Dist: jax>=0.4.18
Dynamic: license-file

# IBCDFO

Interpolation-Based Composite Derivative-Free Optimization, part of [POptUS: Practical Optimization Using Structure](https://github.com/POptUS).

A collection of interpolation-based methods for solving structured,
composite derivative-free optimization problems.

### Repository
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Build Guides](https://github.com/POptUS/IBCDFO/actions/workflows/build_docs.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/build_docs.yml)

[![Coverage Status](https://codecov.io/gh/POptUS/IBCDFO/graph/badge.svg?token=D49I3TI8W2)](https://codecov.io/gh/POptUS/IBCDFO)
[![Measure Code Coverage](https://github.com/POptUS/IBCDFO/actions/workflows/measure_coverage.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/measure_coverage.yml)
[![Test repository tools](https://github.com/POptUS/IBCDFO/actions/workflows/test_tools.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/test_tools.yml)

### MATLAB
[![Check MATLAB Code Standard Adherence](https://github.com/POptUS/IBCDFO/actions/workflows/check_matlab_standards.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/check_matlab_standards.yml)
[![Test IBCDFO MATLAB Code](https://github.com/POptUS/IBCDFO/actions/workflows/test_matlab.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/test_matlab.yml)

### Python
[![Check Python Code Standard Adherence](https://github.com/POptUS/IBCDFO/actions/workflows/check_python_standards.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/check_python_standards.yml)
[![Build & test release candidate](https://github.com/POptUS/IBCDFO/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/release.yml)
[![Test Oldest Versions](https://github.com/POptUS/IBCDFO/actions/workflows/test_python_oldest.yml/badge.svg?branch=main)](https://github.com/POptUS/IBCDFO/actions/workflows/test_python_oldest.yml)

## License & Copyright

All code included in IBCDFO is open source, with the specific license for each component provided in the corresponding top-level
subdirectory. If a subdirectory does not contain a LICENSE file, it is covered by the
IBCDFO [LICENSE](https://github.com/poptus/IBCDFO/blob/main/LICENSE).

Copyright (c) 2023-2026, 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.

## Support

To

* report potential problems with IBCDFO,
* propose a change, or
* request a new feature,

please check if a related [Issue](https://github.com/POptUS/IBCDFO/issues)
already exists before creating a new issue.  For all other communication, please
send an email to the POptUS development team at

 * ``poptus@mcs.anl.gov``

## Documentation

[User and Developer Guides](https://ibcdfo.readthedocs.io) are hosted on ReadTheDocs.

The inclusion of examples is [pending](https://github.com/POptUS/IBCDFO/issues/202).

## Installation & Testing

Refer to the [Getting Started](https://ibcdfo.readthedocs.io/en/latest/get_started.html) section of the User Guide.

## Contributing to IBCDFO

Contributions are welcome in a variety of forms; see
[Contributing](https://ibcdfo.readthedocs.io/en/latest/contributing.html) in the
Developer Guide.

## Cite IBCDFO

```
@techreport{ibcdfo,
  author = {Jeffrey Larson and Matt Menickelly and Stefan M. Wild},
  title  = {Interpolation-Based Composite Derivative-Free Optimization},
  url    = {https://github.com/POptUS/IBCDFO},
  number = {Version 0.1.0},
  year   = {2026},
  doi    = {10.11578/dc.20240627.2}
}
```
