coin-or / coin-or/python-mip

Improve Example Code Readability

Open
#340 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Linear Programming
Stars
600
Forks
108
PR merge metrics
No merged PRs in 30d

Description

Maybe this is because I'm coming from more of a software engineering background than an operations research background, but I find the [code examples](https://python-mip.readthedocs.io/en/latest/examples.html) in the documentation to be very dense and hard to read.

I like the examples, there are some interesting problems there and the code samples do show you how to use the `mip` package to get solutions to them.

However, if you put yourself in the shoes of someone who is evaluating `mip` and trying to imagine how it could be integrated into an actual production system, the code examples fall pretty short.

I figure this is a pretty low-priority issue, but I thought I should at least bring up the topic and provide an example of how the code samples could be improved.

I've re-written the [Plant Location with Non-Linear Costs](https://python-mip.readthedocs.io/en/latest/examples.html#exsos) example as a way of showing what could be possible. If you're interested, please compare my [re-written version](https://gist.github.com/mwerezak/8f2846a4fcace8825291a3632ffd97fc) with the original one. I believe my version is much more readable and would give a reader who is unfamiliar with `mip` a better sense of how it could be integrated into a larger system.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.