Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add new solver CATrustRegionMethod.jl #3900

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

fadihamad94
Copy link

@fadihamad94 fadihamad94 commented Dec 6, 2024

Adding a new solver to the documentation:
Add a new row for the CATrustRegionMethod solver to the table in docs/src/installation.md

Add a new row for the CAT solver to the table in `docs/src/installation.md`
@odow
Copy link
Member

odow commented Dec 7, 2024

Hi @fadihamad94 (and, I see, @ohinder 🇳🇿), we have a checklist for this that needs to be completed before merging:

Basic

  • Check that the solver is a registered Julia package
  • Check that the solver supports the long-term support release of Julia
  • Check that the solver has a MathOptInterface wrapper
  • Check that the tests call MOI.Test.runtests. Some test excludes are
    permissible, but the reason for skipping a particular test should be
    documented.
  • Check that the README and/or documentation provides an example of how to
    use the solver with JuMP

Documentation

  • Add a new row to the table in docs/src/installation.md

Optional

  • Add package metadata to docs/packages.toml

@fadihamad94
Copy link
Author

fadihamad94 commented Dec 10, 2024

HI @odow, below is the checklist:

Basic

  • Check that the solver is a registered Julia package
  • Check that the solver supports the long-term support release of Julia
  • Check that the solver has a MathOptInterface wrapper
  • Check that the tests call MOI.Test.runtests. Some test excludes are
    permissible, but the reason for skipping a particular test should be
    documented.
  • Check that the README and/or documentation provides an example of how to
    use the solver with JuMP

Documentation

  • Add a new row to the table in docs/src/installation.md

Optional

  • Add package metadata to docs/packages.toml

@odow odow changed the title Update installation.md [docs] add new solver CAT.jl Dec 10, 2024
@odow
Copy link
Member

odow commented Dec 10, 2024

Thanks! The requirement to have it registered is a hard-requirement. You're going to struggle to get CAT.jl approved as a name because it is too short. Could you think of a longer name?

Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (00c3b35) to head (9795a80).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3900   +/-   ##
=======================================
  Coverage   99.58%   99.58%           
=======================================
  Files          43       43           
  Lines        6043     6043           
=======================================
  Hits         6018     6018           
  Misses         25       25           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fadihamad94 fadihamad94 changed the title [docs] add new solver CAT.jl [docs] add new solver CATrustRegionMethod.jl Dec 11, 2024
@fadihamad94
Copy link
Author

Hi @odow , thank you for the comment. We updated the package name and registered it JuliaRegistries/General#121222.

@odow
Copy link
Member

odow commented Dec 12, 2024

Great! New packages take three days to merge in case someone wants to comment on the name, but it looks okay to me.

docs/src/installation.md Outdated Show resolved Hide resolved
@odow
Copy link
Member

odow commented Dec 16, 2024

I guess I should update the checklist: can you add GitHub actions to test the package?

You should also add TagBot: https://github.com/jump-dev/JuMP.jl/blob/master/.github/workflows/TagBot.yml

@fadihamad94
Copy link
Author

@odow done. I added GitHub actions to test the package and added TagBot.

Add CATrustRegionMethod solver to the list of available JuMP solvers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants