oemof / demandlib

Creating heat and power demand profiles from annual values.
https://oemof.org
MIT License
56 stars 38 forks source link

Features/improve package setup #5

Closed gplssm closed 7 years ago

gplssm commented 7 years ago

Contains improvements regarding data files contained in the pip package and locations when installed via pip.

gplssm commented 7 years ago

We should discuss if we want to have console scripts for examples of the demandlib. To reduce number of scripts being installed we could implement some simple arg parsing to achieve somthing like

demandlib --examples power

or similar.

uvchik commented 7 years ago

Thank you for your initiative to make the examples accessible after a pip install.

I really like the idea of executing the example in that way, but do you think it will work for Windows users?

gplssm commented 7 years ago

As far as I know, this should work platform independent. @ludee could you test this for us? Just download latest demandlib and checkout the branch features/improve-package-setup. Afterwards install demandlib from local sources by

pip3 install <path-to-sources-of-demandlib>

(or similar adapted to anaconda)

and run the example script by executing

demandlib_heat_example[.exe]

in a command-line.

@uvchik do you think it's worth to use one script for both example differentiating via function arguments?

uvchik commented 7 years ago

All variants are fine for me:

demandlib_example_heat
demandlib_example heat
demandlib_example --heat

With the second and the third variant we would be able to run both examples using demandlib_example all or without parameter.

I would use the variant, that is less work :exclamation:

gplssm commented 7 years ago

Fine! Then decision is made that we have to scripts. Each for an example as currently implemented here.