rl-institut / oemoflex

A flexible model structure for creating and analysing multi-regional sector-integrated energy systems with oemof featuring many flexibility options.

Home Page:https://oemoflex.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Release v0.0.1

jnnr opened this issue · comments

Preparation

  • Finish issues and PRs related to the release
  • Increase version that is installed running pip install oemoflex
  • Test the examples
  • Keep an eye on open issues that are set to your release but seem to be forgotten.
  • Check that the docs look good.

Day of release

  • Optional: Open a release branch to avoid conflicts with other uses while the release progress.
  • Close "forgotten" issues with a recapitulatory comment or set them to a later release if they are still important.
  • Test if everything works
  • If you have failing test fix them or postpone the release.
  • Check the whatsnew-file
  • Check if the latest documentation looks right at readthedocs.
  • Change the version number everywhere!!! (e.g. from 0.2.1dev to 0.2.1) -> pyproject.yaml and docs/conf.py
  • If everything seems to work, merge the release branch into the main branch. (--no-ff)
  • Push your local main branch to the remote.
  • Set a release on github. Select the main branch (default: dev)! A label is set automatically.
  • Use git fetch to see the label in your local main branch.
  • Merge the release branch into the dev branch. (--no-ff)
  • Remove the obsolete release branch.
  • Prepare the dev branch for further development: Adapt the version number at (e.g. from 0.2.1 to 0.2.2dev). Also add a new whatsnew file and a link in the whatsnew.rst file. Open the file locally or use the RAW button to see the links.
  • Close the release issue with informations for the community and relax

Running the examples locally I've seen that they are failing because

  1. from oemof.outputlib.processing import parameter_as_dict should be imported from solph and not from outputlib and
  2. because of KeyError: 'investment_ep_costs' running simple_model.py. investment_ep_costs is hardcoded in these lines in postprocessing.py.

2. because of KeyError: 'investment_ep_costs' running simple_model.py. investment_ep_costs is hardcoded in these lines in postprocessing.py.

I think this is due to missing values in results. I encountered the same, when trying to calculate results from your model in digiplan. We can talk about this on RC, okay?