Here we gather important notes for the developing of oemof and elements within the framework.
We highly encourage you to contribute to further development of oemof. If you want to collaborate see description below or contact us.
Install the developer version¶
To install the developer version two steps are necessary:
git clone email@example.com:oemof/oemof.git sudo pip3 install -e /path/to/the/repository
We mostly follow standard guidelines instead of developing own rules.
PEP8 (Python Style Guide)¶
For strings we use double quotes if possible.
info_msg = "We use double quotes for strings" info_msg = 'This is a string where we need to use "single" quotes'
- We use plural in the code for modules if there is possibly more than one child class (e.g. import transformers AND NOT transformer). If there are arrays in the code that contain multiple elements they have to be named in plural (e.g. transformers = [T1, T2,...]).
- Please, follow the naming conventions of pylint
- Use talking names
- Variables/Objects: Name it after the data they describe (power_line, wind_speed)
- Functions/Method: Name it after what they do: use verbs (get_wind_speed, set_parameter)
So far we adhere mostly to the git branching model by Vincent Driessen.
- instead of the name
origin/developwe call the branch
- feature branches are named like
- release branches are named like
We use nosetests for testing. Make sure that all tests are successfull before
merging back into the
cd /path/to/oemof/ nosetests3 --with-doctest # or nosetests3 --with-doctest --rednose # if you like it
Section about workflow for issues is still missing (when to assign an issue with what kind of tracker to whom etc.).