Consistent locations for examples

[p-snft]

Currently, some of the examples are provided within this repository. Namely, this is the case for solph, tespy, and windpowerlib. Other examples are located within the individual packages:

• demandlib
• feedinlib
• DHNx
• thermal

As we request examples for new features and need to change them for new API versions, it makes sense to have them inside the packages. However, it would also be possible to focus on applications (e.g. heat network) instead of packages (e.g. tespy or DHNx). This way also would simplify sorting examples that use multiple packages (e.g. thermal, tespy, solph, and demandlib).

What should we do?

[joroeder]

For examples using multiple packages, this would really make sense. Are there that many examples using multiple oemof packages?

I am not sure if it makes sense for all examples. Then, every examples needs to be assigned to some topic. Maybe, this is something additional. If somebody has a nice model/example/workflow using multiple packages, a content-oriented structure could really nice for that.

And yes, at the moment, it is not consistent. For DHNx, it is still in the early development (not released so far), so it was more convenient to have examples directly in the package. I think this could be changed later on. However, you are also indicating that putting them within the package would make more sense anyway?

[p-snft]

However, you are also indicating that putting them within the package would make more sense anyway?

For at least one reason, it is: Examples sitting within the repository would always be at a consistent/ the correct state of the API. I.e., when adding a feature to solph, I have to provide an example. This cannot be tested automatically, as the feature is not yet available outside solph's corresponding feature branch.

[p-snft]

This might be a topic for the next dev meeting.

[jokochems]

Update: The dev meeting discussion this morning made clear that more discussions and user opinions are needed in order to decide on that.