documentation desires - Githubissues

convexengineering / gpkit

Geometric programming for engineers

http://gpkit.readthedocs.org

MIT License

206 stars 40 forks source link

documentation desires #1280

Open bqpd opened 6 years ago

bqpd commented 6 years ago

[ ] document string/varkey access (#668)
[ ] document cost setting in named models (https://github.com/convexengineering/gpkit/issues/1420)
[ ] document solution arrays (#565)
[ ] expand GeometricProgram docstring, to include v_ss, nu_by_posy, posynomials, hmaps, k, p_idxs, m_idxs, meq_idxs, cs.
[ ] document Constants (#1276)
[ ] document ConstraintSet (#1223)
[ ] add "Signomial Programming 101" (#207)

1ozturkbe commented 6 years ago

@bqpd @nillst I am interested in learning more about and documenting the gpkit.interactive tools (esp. dashboard) using some examples I created. @nillst if you have any example code or repos I can reference that would be great.

1ozturkbe commented 6 years ago

@nillst @bqpd bump!

bqpd commented 6 years ago

All we've got is in the repo, really! Most of the methods are hopefully fairly self-documenting or have defaults.

1ozturkbe commented 6 years ago

There seriously are no demos for these functions? It would have been nice to have a MWE and not to have to read through the methods to get started. I will have to do this after we merge SimPleAC so we can have a half-decent example.