Skip to content

JuliaSmoothOptimizers/OptimizationProblems.jl

Repository files navigation

OptimizationProblems

DOI CI Build Status codecov Documentation/stable Documentation/dev

This package provides a collection of optimization problems in JuMP and ADNLPModels syntax.

Installing

OptimizationProblems can be installed and tested through the Julia package manager:

julia> ]
pkg> add OptimizationProblems
pkg> test OptimizationProblems

This package collects all the metadata of the implemented problems in a single DataFrame.

using OptimizationProblems
OptimizationProblems.meta

This module is particularly useful in conjunction with NLPModels to facilitate evaluating objective, constraints and their derivatives.

Contributing

Please open pull requests to submit new problems! When submitting a problem, please pay particular attention to the documentation. We would like to gather as much information as possible on the provenance of problems. The documentation Contributing provides general guidelines on how to suggest new problems.

How to cite

If you use OptimizationProblems.jl in your work, please cite using the format given in CITATION.cff.

Bug reports and discussions

If you think you found a bug, feel free to open an issue. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

If you want to ask a question not suited for a bug report, feel free to start a discussion here. This forum is for general discussion about this repository and the JuliaSmoothOptimizers, so questions about any of our packages are welcome.