[docs] Add Optim to list of solvers

jump-dev / JuMP.jl

Modeling language for Mathematical Optimization (linear, mixed-integer, conic, semidefinite, nonlinear)

http://jump.dev/JuMP.jl/

Other

2.24k stars 396 forks source link

[docs] Add Optim to list of solvers #3624

Closed blegat closed 9 months ago

blegat commented 11 months ago

Preview https://jump-dev.github.io/JuMP.jl/previews/PR3624

Basic

[x] Check that the solver is a registered Julia package
[x] Check that the MOI wrapper is part of the latest release
[x] Check that the solver supports the long-term support release of Julia
[x] Check that the solver has a MathOptInterface wrapper
[x] Check that the tests call MOI.Test.runtests. Some test excludes are permissible, but the reason for skipping a particular test should be documented.
[x] Check that the README and/or documentation provides an example of how to use the solver with JuMP https://github.com/JuliaNLSolvers/Optim.jl/pull/1059

Documentation

[x] Add a new row to the table in docs/src/installation.md

Optional

[x] Add package metadata to docs/packages.toml

cc @pkofod

codecov[bot] commented 11 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (9e2e263) 98.21% compared to head (5892707) 98.29%. Report is 31 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3624 +/- ## ========================================== + Coverage 98.21% 98.29% +0.07% ========================================== Files 43 43 Lines 5653 5676 +23 ========================================== + Hits 5552 5579 +27 + Misses 101 97 -4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

odow commented 9 months ago

@blegat the issue now is that the Optim README doesn't conform to our needs: https://jump.dev/JuMP.jl/previews/PR3624/packages/Optim/

Perhaps we could just omit the README for now?

pkofod commented 9 months ago

the issue now is that the Optim README doesn't conform to our needs:

where can I find the requirements?

odow commented 9 months ago

It needs to be documenter markdown, not GitHub markdown :smile:

You can see from the image above. The links don't work, and it needs to be ```math instead of $$. It can be painful to get right. But I can take a look if you don't mind me making seeming pointless changes to the README just so JuMP can embed the README in our docs.

pkofod commented 9 months ago

It needs to be documenter markdown, not GitHub markdown 😄

You can see from the image above. The links don't work, and it needs to be ```math instead of $$. It can be painful to get right. But I can take a look if you don't mind me making seeming pointless changes to the README just so JuMP can embed the README in our docs.

If you have time! Otherwise I'll try to get to it early next week.

odow commented 9 months ago

See https://github.com/JuliaNLSolvers/Optim.jl/pull/1076

pkofod commented 9 months ago

https://github.com/JuliaRegistries/General/pull/100311

odow commented 9 months ago

https://jump.dev/JuMP.jl/previews/PR3624/packages/Optim/