pyomo icon indicating copy to clipboard operation
pyomo copied to clipboard

[PEP] Process for handling/testing examples

Open blnicho opened this issue 1 year ago • 0 comments

Summary

Pyomo examples are inconsistent in how they are implemented and tested and where they are located. We should come up with, implement, and document a process for how examples should be handled within repositories under the Pyomo GitHub organization.

Rationale

A coherent and standardized process will help us keep existing examples organized and maintained and will help future developers who wish to contribute examples.

Relevant comment from @bernalde from #2932:

Where should we draw the line between a set of examples, tests, and supported models? In particular, for GDP, we have GDPLib https://github.com/SECQUOIA/gdplib, which could host these two examples. What's the motivation for adding examples to the main Pyomo repository?

Description

Related issues/tasks:

  • [ ] https://github.com/Pyomo/pyomo/issues/101
  • [ ] https://github.com/Pyomo/pyomo/issues/1026
  • [x] https://github.com/Pyomo/pyomo/issues/1950

blnicho avatar Aug 22 '23 18:08 blnicho