Release v0.0.2

[MaGering]

This issue serves as a collection of todos for the release process of v0.0.2. We use oemof's how to release as an orientation (See a boiled-down version of the release todos below): https://github.com/oemof/oemof/wiki/How-to-release

Preparation

• Finish issues and PRs related to the release https://github.com/rl-institut/oemof-B3/milestones/v0.0.2
• Test the examples
• Keep an eye on open issues that are set to your release but seem to be forgotten.
• [x] Check that the docs look good. (https://github.com/rl-institut/oemof-B3/pull/251)
• [x] check headers of python scripts
• [x] Check fresh installation and run
• [x] check that oemoflex contains all necessary features/fixes
• [x] Download raw data from zenodo
• [x] Should add a line to readme/docs on how to run all scenarios (snakemake -j1 run_all_scenarios).
• [x] Should mention that debug = true by default.

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 it works
  • [x] Install in a fresh environment
  • [x] Examples
  • [x] Scenarios
  • [x] Plots
  • [ ] Tables
  • [ ] Reports
  • [x] Check for obsolete snakemake rules/options
• 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!!! [TODO] (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.
• Edit-Zenodo-entry
• Close the release issue with informations for the community and relax

[jnnr]

When I install oemof-B3 on a fresh environment and run the pipeline, build_datapackage throws an error

ModuleNotFoundError: No module named 'oemoflex.config'
Traceback (most recent call last):
  File "scripts/build_datapackage.py", line 34, in <module>
    from oemoflex.model.datapackage import EnergyDataPackage
  File "oemof-B3/lib/python3.8/site-packages/oemoflex/model/datapackage.py", line 13, in <module>
    from oemoflex.config.config import settings
ModuleNotFoundError: No module named 'oemoflex.config'

I can avoid this by installing the local version of oemoflex. But it should work without me doing that.

[jnnr]

Should add a line to readme/docs on how to run all scenarios (snakemake -j1 run_all_scenarios). Should mention that debug = true by default.

[MaGering]

Do we need to fix issue https://github.com/rl-institut/oemof-B3/issues/303 before the release @jnnr?

[jnnr]

When I install oemof-B3 on a fresh environment and run the pipeline, build_datapackage throws an error

ModuleNotFoundError: No module named 'oemoflex.config'
Traceback (most recent call last):
  File "scripts/build_datapackage.py", line 34, in <module>
    from oemoflex.model.datapackage import EnergyDataPackage
  File "oemof-B3/lib/python3.8/site-packages/oemoflex/model/datapackage.py", line 13, in <module>
    from oemoflex.config.config import settings
ModuleNotFoundError: No module named 'oemoflex.config'

I can avoid this by installing the local version of oemoflex. But it should work without me doing that.

Fixed with https://github.com/rl-institut/oemoflex/pull/89

[MaGering]

Done! https://github.com/rl-institut/oemof-B3/releases/tag/v0.0.2 Zenodo has been updated too with the new version of oemof-B3: https://zenodo.org/record/7685137#.Y_4rsuuZNhE