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

Revise Example #247

Merged
merged 27 commits into from Mar 9, 2017

Conversation

Projects
None yet
4 participants
@uvchik
Copy link
Member

uvchik commented Nov 10, 2016

If new users will use oemof, the example are one important entry to the oemof cosmos.

In addition to PR #238 the revision of the example should be completed.

  • Stored csv-file of csv-dispatch example should be more user-friendly @ckaldemeyer
  • example script should allow to choose the solver with optional parameter to check the installation with optional parameter (default: cbc) @gplssm
  • Check output of examples if executed from script @uvchik
  • Add testing "example" @uvchik

Check comments inside examples
(e.g. by someone who did not created the example) @oemof/oemof-solph

  • csv-reader - invest
  • csv-reader - dispatch @uvchik
  • flexible modelling
  • simple dispatch @uvchik
  • storage invest @uvchik

Check whether the description of your example is okay -> here

uvchik added some commits Nov 10, 2016

@uvchik uvchik added this to the v0.1.2 milestone Nov 11, 2016

@uvchik uvchik self-assigned this Nov 11, 2016

@uvchik uvchik added the enhancement label Nov 11, 2016

gplssm added some commits Nov 13, 2016

Fix broken link to example data
Due to renaming of directories, .csv files could be found.
@simnh

This comment has been minimized.

Copy link
Member

simnh commented Jan 2, 2017

What about this one ?

@uvchik uvchik added the help wanted label Jan 2, 2017

@uvchik uvchik requested review from simnh , c-moeller and ckaldemeyer Jan 2, 2017

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Jan 2, 2017

I changed the description to make things clearer.

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Jan 2, 2017

If you think your name shouldn't be there please write a comment and remove your name.

@simnh

This comment has been minimized.

Copy link
Member

simnh commented Feb 20, 2017

What about this one? Can the person assigned to task do it and we can merge this one soon?

uvchik added some commits Mar 3, 2017

Merge branch 'dev' of github.com:oemof/oemof into features/revise_exa…
…mples

Conflicts:
	doc/installation_and_setup.rst
	doc/whatsnew/v0-1-2.rst
@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 3, 2017

@ckaldemeyer 'Would you add your new unstack function to the csv examples to make the results stored in a csv-file readable.

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 3, 2017

I added a testing example.

The output looks like this:

*********
Solver installed with oemof:
gurobi: not working
cbc: working
cplex: not working
glpk: working
*********
oemof successfully installed.
@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 6, 2017

@ckaldemeyer 'Would you add your new unstack function to the csv examples to make the results stored in a csv-file readable.

I could do it. In both of them? I think one example would be sufficient.

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 7, 2017

I could do it. In both of them? I think one example would be sufficient.

Yes.

Please the check boxes of the first comment.

uvchik added some commits Mar 7, 2017

Merge branch 'dev' of github.com:oemof/oemof into features/revise_exa…
…mples

Conflicts:
	doc/installation_and_setup.rst
@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 7, 2017

Please the check boxes of the first comment.

Check

ckaldemeyer added some commits Mar 7, 2017

@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 7, 2017

Stored csv-file of csv-dispatch example should be more user-friendly @ckaldemeyer

I don't know who wrote this and what is meant by it exactly. The CSV file contains a description of its structure and should be self-explaining, the solver is CBC and the examples are linked correctly in the documentation. From this point I think it should be fine.

Or am I missing something?

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 7, 2017

Stored csv-file of csv-dispatch example should be more user-friendly @ckaldemeyer

That was about the output file. The output file is one column and as we talked (a long time ago) we agreed that it would be more user-friendly if we would store it in a different way. Maybe a bus-balance-slice before the to_csv will do the trick.

@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 8, 2017

That was about the output file. The output file is one column and as we talked (a long time ago) we agreed that it would be more user-friendly if we would store it in a different way. Maybe a bus-balance-slice before the to_csv will do the trick.

Ah, you're right.. Thanks! I'll do it this afternoon.

@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 8, 2017

That was about the output file. The output file is one column and as we talked (a long time ago) we agreed that it would be more user-friendly if we would store it in a different way. Maybe a bus-balance-slice before the to_csv will do the trick.

I have now added a part that saves one csv-file with outputs/inputs/other per bus.

We could also add this as a method to the ResultsDataFrame like "bus_balance_to_csv" with a list of busses as argument and per default all busses to be written to the file system. I guess this function might be used quite often..

What do you think?

@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Mar 8, 2017

I have now added a part that saves one csv-file with outputs/inputs/other per bus.

We could also add this as a method to the ResultsDataFrame like "bus_balance_to_csv" with a list of busses as argument and per default all busses to be written to the file system. I guess this function might be used quite often..

What do you think?

I think this would be useful and just implemented this functionality in the RDF. Please check if something's missing

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 9, 2017

I think the examples are much cleaner now and this lowers the entry barrier for new users.

Thank you @simnh, @gplssm and @ckaldemeyer for your help.

@uvchik uvchik removed the request for review from c-moeller Mar 9, 2017

@uvchik

This comment has been minimized.

Copy link
Member Author

uvchik commented Mar 9, 2017

I think this would be useful and just implemented this functionality in the RDF. Please check if something's missing

I really get used to the MulitiIndex DataFrame but within office-applications the new form is much better. Cool feature 🎉

uvchik added some commits Mar 9, 2017

Merge branch 'dev' of github.com:oemof/oemof into features/revise_exa…
…mples

Conflicts:
	doc/oemof_solph.rst
	doc/whatsnew/v0-1-2.rst
	examples/examples.py
	examples/solph/storage_investment/storage_investment.py

@uvchik uvchik merged commit c7d0cdf into dev Mar 9, 2017

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@uvchik uvchik deleted the features/revise_examples branch Mar 9, 2017

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