★ wanayoo — archive 1999 https://github.com/JWally/jsLPSolver/issues/24Nouvelle recherche | Portail wanayoo
Skip to content

/ jsLPSolver

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

Jump to bottom

Feature Documentation #24

Open
JWally opened this issue Dec 9, 2015 · 5 comments
Open

Feature Documentation #24

JWally opened this issue Dec 9, 2015 · 5 comments

Comments

@JWally
Copy link
Owner

@JWally JWally commented Dec 9, 2015

@bchevalier,

Would you be up for helping me better document this library's functionality?
No rush at all, but I haven't done a great job of documenting what is in this library or how to use it very well. I figure we can kick around what all to include in this thread until we're comfortable moving over pieces to the readme.

For instance, I think you've made it possible to have free-variables (no 0 floor), but I'd have to dig in the tests on how to use it.

So here's my first pass at an outline:

  • What is the library, what does it do?
  • Explanation of model parts (opType, variables, int, etc)
  • Function API
  • (Alt) Input Styles
    • Object Model
    • Text File
    • Array
  • Other Functionality
  • Examples (?)

Again, I'm in no rush to get this done, but I think a good documentation would be useful.
Thoughts?
@bchevalier
Copy link
Collaborator

@bchevalier bchevalier commented Dec 12, 2015

I also think that would be a good idea to improve the documentation.
I am not so available these days, it will be a couple of months before I involve myself in the documentation.
@lvenerosy
Copy link
Contributor

@lvenerosy lvenerosy commented Feb 26, 2016

I would like to do some modifications on the documentation to make people understand more quickly what is jsLPSolver and to help contributors :

  • quick introduction on mixed integer linear problems (with a few words on the simplex and branch and cut)
  • a few study cases (like the knapsack)
  • better examples to display linear problems and mixed linear problems
  • both the JSON version and the API version for these problems
  • a few intermediate instances in the tens of variables/constraints
  • a class diagram
  • a flow chart of a problem solving from the user input to the solution

@JWally, Any advice or anything to prioritize ?
@JWally
Copy link
Owner Author

@JWally JWally commented Feb 26, 2016

@lvenerosy, this is all great! Whatever you feel like working through first, I'm good with.

The only request would be that if you modify the readme, try and keep the intro and "getting started" section gentle so that a non-mathemagician's eyes don't glaze over :P. After that, please feel free to go to town!
@JWally
Copy link
Owner Author

@JWally JWally commented Feb 26, 2016

btw, @lvenerosy; would you like me to list you as a contributor? If so, let me know how you want in there.

Thanks again!
@lvenerosy
Copy link
Contributor

@lvenerosy lvenerosy commented Mar 3, 2016

@JWally, yes that would be nice thank you.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@bchevalier @JWally @lvenerosy
You can’t perform that action at this time.