[](https://github.com/jump-dev/Hypatia.jl/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/gh/jump-dev/Hypatia.jl)
[](https://jump.dev/Hypatia.jl/stable)
[](https://jump.dev/Hypatia.jl/dev)
[Hypatia](https://github.com/jump-dev/Hypatia.jl) is a highly customizable open source interior point solver for generic conic optimization problems, written in [Julia](https://julialang.org/).
For more information on Hypatia, please see:
- [documentation](https://jump.dev/Hypatia.jl/dev) for Hypatia's conic form, predefined cones, and interfaces
- [cones reference](https://github.com/jump-dev/Hypatia.jl/wiki/files/coneref.pdf) for cone definitions and oracles
- [examples folder](https://github.com/jump-dev/Hypatia.jl/tree/master/examples) for applied examples and instances
- [benchmarks folder](https://github.com/jump-dev/Hypatia.jl/tree/master/benchmarks) for scripts used to run and analyze various computational benchmarks
and preprints of our papers:
- [Solving natural conic formulations with Hypatia.jl](https://arxiv.org/abs/2005.01136) for computational arguments for expanding the class of cones recognized by conic solvers
- [Performance enhancements for a generic conic interior point algorithm](https://arxiv.org/abs/2107.04262) for a description of Hypatia's algorithm and our enhanced stepping procedures
- [Sum of squares generalizations for conic sets](https://arxiv.org/abs/2103.11499) for barriers and computational techniques for our generalized polynomial sum of squares cones
- [Conic optimization with spectral functions on Euclidean Jordan algebras](https://arxiv.org/abs/2103.04104) for barriers and computational techniques for many of our epigraph/hypograph cones
and corresponding [raw results CSV files](https://github.com/jump-dev/Hypatia.jl/wiki) generated by our run scripts in the benchmarks folder.
## Getting help
If you need help, please ask a question on the [JuMP community forum](https://jump.dev/forum).
If you have a reproducible example of a bug, please [open a GitHub issue](https://github.com/jump-dev/Hypatia.jl/issues/new).
## License
Hypatia is licensed under the MIT License (see [LICENSE](https://github.com/jump-dev/Hypatia.jl/blob/master/LICENSE.md)).
## Installation
To use Hypatia, install [Julia](https://julialang.org/downloads/), then at the Julia REPL, type:
```julia
using Hypatia
using Pkg
Pkg.add("Hypatia")
```
Hypatia is an experimental solver and a work in progress, and may not run with older releases of Julia.
Default options/parameters are not well-tuned, so we encourage you to experiment with these.
## Usage
Hypatia can be accessed through a low-level native Julia interface or through open-source modeling tools such as [JuMP](https://github.com/jump-dev/JuMP.jl) and [Convex.jl](https://github.com/jump-dev/Convex.jl).
The native interface is more expressive, allowing Hypatia to solve conic models expressed with generic real floating point types and structured matrices or linear operators, for example.
However, it is typically sufficient and more convenient to use JuMP.
Using JuMP, we can model a simple D-optimal experiment design problem and call Hypatia:
```julia
using LinearAlgebra
using JuMP
using Hypatia
model = Model(() -> Hypatia.Optimizer(verbose = false))
@variable(model, x[1:3] >= 0)
@constraint(model, sum(x) == 5)
@variable(model, hypo)
@objective(model, Max, hypo)
V = rand(2, 3)
Q = V * diagm(x) * V'
aff = vcat(hypo, [Q[i, j] for i in 1:2 for j in 1:i]...)
@constraint(model, aff in MOI.RootDetConeTriangle(2))
# solve and query solution
optimize!(model)
termination_status(model)
objective_value(model)
value.(x)
```
See our [D-optimal design](https://github.com/jump-dev/Hypatia.jl/blob/master/examples/doptimaldesign/JuMP.jl) example for more information and references.
Many more examples using the native interface or JuMP can be found in the [examples folder](https://github.com/jump-dev/Hypatia.jl/tree/master/examples).
## Contributing
Comments, questions, suggestions, and improvements/extensions to the code or documentation are welcomed.
Please reach out on [Discourse](https://discourse.julialang.org/c/domain/opt), or submit an issue or contribute a PR on our [GitHub](https://github.com/jump-dev/Hypatia.jl).
If contributing code, try to maintain consistent style and add docstrings or comments for clarity.
New examples are welcomed and should be implemented similarly to the [existing examples](https://github.com/jump-dev/Hypatia.jl/tree/master/examples).
## Acknowledgements
This work has been partially funded by the National Science Foundation under grant OAC-1835443 and the Office of Naval Research under grant N00014-18-1-2079.
## Citing Hypatia
If you find Hypatia solver useful, please cite our [solver paper](https://pubsonline.informs.org/doi/abs/10.1287/ijoc.2022.1202):
```bibtex
@article{coey2022solving,
title={Solving natural conic formulations with {H}ypatia.jl},
author={Chris Coey and Lea Kapelevich and Juan Pablo Vielma},
year={2022},
journal={INFORMS Journal on Computing},
publisher={INFORMS},
volume={34},
number={5},
pages={2686--2699},
doi={https://doi.org/10.1287/ijoc.2022.1202}
}
```
If you find aspects of Hypatia's IPM implementation useful, please cite our [algorithm paper](https://link.springer.com/article/10.1007/s12532-022-00226-0):
```bibtex
@article{coey2022performance,
title={Performance enhancements for a generic conic interior point algorithm},
author={Chris Coey and Lea Kapelevich and Juan Pablo Vielma},
year={2023},
journal={Mathematical Programming Computation},
publisher={Springer},
volume={15},
pages={53--101},
doi={https://doi.org/10.1007/s12532-022-00226-0}
}
```