Skip to content
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

Version 0.3 examples #26

Open
simnh opened this issue Nov 8, 2018 · 7 comments
Open

Version 0.3 examples #26

simnh opened this issue Nov 8, 2018 · 7 comments

Comments

@simnh
Copy link
Member

simnh commented Nov 8, 2018

I added an directory for the oemof 0.3 examples. Currently there is only one new example for the the new core that will be in the new version.

I hope it's ok to have this on the dev? I was not quite sure how we handle this here in terms of aligning the process of oemof development with the examples repository..

@uvchik
Copy link
Member

uvchik commented Nov 12, 2018

Last time we added a a folder to the dev branch and copied all examples from the the previous version. Right before the release we move all non-working examples to feature branches and merged all working examples to the master on the release day. We thought that it would be confusing to have examples on the master before the release is published.

@uvchik
Copy link
Member

uvchik commented Nov 12, 2018

Thank you for starting the process.

@p-snft
Copy link
Member

p-snft commented Nov 13, 2018

I was not quite sure how we handle this here in terms of aligning the process of oemof development with the examples repository..

Synchronization is a tough thing, yes. I thought about applying the git workflow also for the examples, but this would mean that there are non-working combinations that are not explicitly visible as such. Maybe, just editing dev is a good idea.

I would suggest to add them using feature branches (or one feature branch) instead of copying them without testing. In my opinion, there should also be an API freeze before finally merging them into dev.

@uvchik
Copy link
Member

uvchik commented Nov 13, 2018

I would suggest to add them using feature branches (or one feature branch) instead of copying them without testing.

I think you got me wrong. Last time we copied all 0.1 examples to the 0.2 folder with a list and a responsible person for each example. This person was responsible to adapt the example to 0.2 until the release. It is also possible to do this in a feature branch but as all examples stand alone and do not rely on each other this is not necessary.

@uvchik
Copy link
Member

uvchik commented Nov 13, 2018

What about adding windpowerlib, TESPY,.. examples as well.

@simnh
Copy link
Member Author

simnh commented Nov 14, 2018

I would suggest to add them using feature branches (or one feature branch) instead of copying them without testing.

I think you got me wrong. Last time we copied all 0.1 examples to the 0.2 folder with a list and a responsible person for each example. This person was responsible to adapt the example to 0.2 until the release. It is also possible to do this in a feature branch but as all examples stand alone and do not rely on each other this is not necessary.

Let's just have all v0.3 examples on the dev branch and merge once v0.3 is released.

BTW I like adding other example but then I would suggest to a one hierarchic like this using the repositories as a reference:

  • oemof-solph
  • oemof-core
  • oemof-tabular (to come ;-) )
  • tespy
  • ...

Of course the examples mix usage of all stuff, but nevertheless dedicated folders are quite useful I guess if people are only interested in understanding tespy for exmaple...

@uvchik
Copy link
Member

uvchik commented Nov 14, 2018

Good idea and 0.2, 0.3 are subfolders of solph, right? But I would start only with folders that have at least one example.

@simnh Would you open a PR?

@SabineHaas Would you add the windpowerlib examples?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

10 participants