Restructure / refactor optimization modules

oemof / DHNx

District heating system optimisation and simulation models

MIT License

27 stars 12 forks source link

Restructure / refactor optimization modules #77

Closed joroeder closed 2 years ago

joroeder commented 3 years ago

This PR restructures the optimization modules and puts them into `dhnx.optimization.

For the user, (at least for all examples), this does change anything as the network optimization is implemented as method of the ThermalNetwork (ThermalNetwork.optimize_investment()). It is all under the hood.

For the simulation part, there are no changes at all, it only addresses the optimization part.

[x] refactor modules
[x] check and fix sphinx API documentation build (fixes #67 ) ~~Add CI again~~ > done by #78
[x] Update WhatsNew

coveralls commented 3 years ago

Pull Request Test Coverage Report for Build 1078035058

28 of 28 (100.0%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.5%) to 53.548%

Totals
Change from base Build 1077738192:	0.5%
Covered Lines:	1037
Relevant Lines:	1809

💛 - Coveralls

joroeder commented 3 years ago

@jnettels @jnnr If somebody could have a short look on that one, e.g. check the examples, would be really nice :)

As a re-structuring sometimes can imply conflicts, however, if there are errors at restructuring, normally, the imports do not work, which I could not encounter here.

Maybe, a short comment, on what do you think about the here proposed putting all modules concerned with optimization in a folder, would be great. I also think, if the development continues, we can also re-think the modules structure time by time. For now, this seems to make sense to me, so I could add further modules for pre- and post-processing for the optimization in submodules in that folder.