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

Add Options reference section #15

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

davidyeiser
Copy link

Description

Adds new Options reference section to README.

Changes

  • Update README with documentation from Nextmv Docs site on using options with MIP apps.

Copy link
Member

@sebastian-quintero sebastian-quintero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to remove OR-Tools, Pyomo and exclude some lines from markdown linting.

Comment on lines +24 to +25
| [OR-Tools][ortools-section] | Open-source solver interface for various solvers. Included open-source solvers: `CLP`, `GLOP`, `PDLP`, `SCIP`. |
| [Pyomo][pyomo-section] | Open-source interface for various solvers. Included open-source solvers in Cloud: `CBC`, `GLPK`. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo doesn’t know about OR-Tools and Pyomo, so we need to eliminate all mentions of them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also need to point to the actual implementing repos (only highs atm). So, we need to remove xpress as well. And link go-highs repo as users need to import that one directly as well.

11 cols (11 binary, 0 integer, 0 implied int., 0 continuous)
11 nonzeros

Nodes | B&B Tree | Objective Bounds | Dynamic Constraints | Work
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to use the markdownlint exclude thing for these statements.

Copy link
Member

@merschformann merschformann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is some confusion left about what this repo does. I won't block as I am out, but feel free to ping me if things are unclear. 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants