Reference Manual

This reference manual provides in-depth information about all general framework functionalities and models HydPy offers. Also, it lists all submodel interfaces, which are standardised connections for coupling main models and submodels.

HydPy has a so-called complete (line-based) test coverage, meaning automatised test bots analyse each HydPy build thoroughly. We achieved this desirable goal by writing an extremely high number of doctests, which are “normal” unit or integration tests visible in the documentation. As a result, reading this reference manual takes some time (and we advise not only to read but also repeat the tests in a Python shell), but it covers all details and edge cases we thought to be relevant (for example, tests of expected user errors). Therefore, please refrain from reading this reference manual from front to back. You will likely benefit more from working through the Quick Start section and the User Guide and, afterwards, from searching for more specific information in this reference manual.