Pyomo decorators need documented

Pyomo / pyomo

An object-oriented algebraic modeling language in Python for structured optimization problems.

https://www.pyomo.org

Other

1.95k stars 504 forks source link

Pyomo decorators need documented #1039

Open michaelbynum opened 5 years ago

blnicho commented 5 years ago

Starting a list of decorators that should be documented:

[ ] decorator notation for declaring Pyomo components
[ ] deprecation decorator (#944)
[ ] the custom block decorator

carldlaird commented 5 years ago

Added the custom block decorator to Bethany's list.

goroderickgo commented 2 years ago

I can't promise anything any time soon, but my team has been starting to use the decorator syntax for model components (e.g., @self.Constraint, etc.) and would greatly benefit from having this functionality documented. With some guidance, I'd be happy to (eventually) contribute something to the Pyomo documentation.

blnicho commented 2 years ago

@goroderickgo, this slide from the Pyomo Workshop materials is a good place to start.

liyingbin1213 commented 1 year ago

you can also see more examples in this book. https://jckantor.github.io/MO-book/intro.html