# -*- coding: utf-8 -*-
"""Module |config| allows the user to configure `HydPy`.

The available options should not be changed during runtime.
"""
USEAUTODOC = False
"""A flag that indicates whether *HydPy's* automatic documentation 
manipulation features should be applied or not.  It is imperative to 
set it to `True` before one uses `Sphinx` to generate the online 
documentation.  However, one can set it to `False` for regular 
applications, which reduces *HydPy's* initialisation time."""

FASTCYTHON = True
"""A flag which indicates whether cythonizing should result in faster 
but more fragile models or slower but more robust models.  Setting this 
flag to False can be helpful when the implementation of new models or 
other Cython related features introduces errors that do not result in 
informative error messages."""

PROFILECYTHON = False
"""A flag which indicates if cythonized models should be fully accessible 
during profiling.  Setting this flag to True decreases performance and 
should be done my model or framework developers only."""
