https://github.com/juliasmoothoptimizers/jsosolverskeleton.jl

JSO-compliant Solver templates
https://github.com/juliasmoothoptimizers/jsosolverskeleton.jl

Last synced: 6 months ago
JSON representation

JSO-compliant Solver templates

• Host: GitHub
• URL: https://github.com/juliasmoothoptimizers/jsosolverskeleton.jl
• Owner: JuliaSmoothOptimizers
• License: mit
• Created: 2020-11-16T14:02:29.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-14T14:24:42.000Z (over 1 year ago)
• Last Synced: 2025-09-04T19:59:36.504Z (11 months ago)
• Language: Julia
• Size: 207 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# JSOSolverSkeleton

[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaSmoothOptimizers.github.io/JSOSolverSkeleton.jl/stable)

[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaSmoothOptimizers.github.io/JSOSolverSkeleton.jl/dev)

[![Build Status](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/workflows/Test/badge.svg)](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions)

[![Test workflow status](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Test.yml?query=branch%3Amain)

[![Lint workflow Status](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Lint.yml?query=branch%3Amain)

[![Docs workflow Status](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/actions/workflows/Docs.yml?query=branch%3Amain)

[![Build Status](https://api.cirrus-ci.com/github/JuliaSmoothOptimizers/JSOSolverSkeleton.jl.svg)](https://cirrus-ci.com/github/JuliaSmoothOptimizers/JSOSolverSkeleton.jl)

[![Coverage](https://codecov.io/gh/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaSmoothOptimizers/JSOSolverSkeleton.jl)

[![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME)

--------------

*JSOSolverSkeleton* is a solver for constrained nonlinear problems, i.e.,

optimization problems of the form

```math

\begin{aligned}

\min \quad & f(x) \\

& c_L \leq c(x) \leq c_U \\

& \ell \leq x \leq u,

\end{aligned}

```

It uses other [JuliaSmoothOptimizers](https://jso.dev) packages for development.

In particular, [NLPModels.jl](https://github.com/JuliaSmoothOptimizers/NLPModels.jl) is used for defining the problem, and [SolverCore](https://github.com/JuliaSmoothOptimizers/SolverCore.jl) for the output.

## How to Cite

If you use JSOSolverSkeleton.jl in your work, please cite using the format given in [CITATION.cff](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/blob/main/CITATION.cff).

## Installation



JSOSolverSkeleton is a  

    

        

        Julia Language

    

      package. To install JSOSolverSkeleton,

    please open

    Julia's interactive session (known as REPL) and press ] key in the REPL to use the package mode, then type the following command



```julia

pkg> add JSOSolverSkeleton

```

## Example

```julia

using JSOSolverSkeleton, ADNLPModels

# Rosenbrock

nlp = ADNLPModel(x -> 100 * (x[2] - x[1]^2)^2 + (x[1] - 1)^2, [-1.2; 1.0])

stats = jsosolverskeleton(nlp)

```

## Contributing

If you think you found a bug, feel free to open an [issue](https://github.com/JuliaSmoothOptimizers/JSOSolverSkeleton.jl/issues).

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 make contributions of any kind, please first that a look into our [contributing guide directly on GitHub](docs/src/contributing.md) or the [contributing page on the website](https://JuliaSmoothOptimizers.github.io/JSOSolverSkeleton.jl/dev/contributing/).

---

This repo was created with the [COPIERTemplate.jl](https://github.com/abelsiqueira/COPIERTemplate.jl) package.