$$ \newcommand{\D}{\displaystyle} \renewcommand{\eqref}[1]{Eq.~(\ref{#1})} $$




9 Python Style Guide

PEP 8, and Google have python style guides which we generally try to follow, though we have made some different choices in some respect.

9.1 The conventions we use

First off we try to be compliant to the https://www.python.org/dev/peps/pep-0008/ the summary is as follows:

9.2 Summary

9.3 The code is the documentation... i.e. the docs always lie!

Write the code as clearly as possible to what it is doing. Clear, succinct variable names and conventions, and ideally code review.

9.4 Docstring Guide

The google docstring guide is located at Google Style Python Docstrings