Version 0.3.1

v0.3.1 (June 2020)

This is a minor release introducing a user-friendly option to rename interaction
functions as well as constraints for optimized parameters.
An initial documentation has been drafted and is hosted on readthedocs.io.

Importing and renaming interaction functions

• init_alternative_interaction_names( )
  This is called when ever a new model i initialized.
  It checks if alternative names for an existing interaction were declared in the
  yaml configuration file.
  For details check the
  docs.

• import_interaction_functions( )
  This can be called in the execution file by the user to import user-defined or
  renamed interaction functions.
  For details check the
  docs.

The previous version of renaming interaction functions was to declare the
alternative names in the execution file. However, this did not work consistently
in all execution environments. Therefore, we now introduce to dedicated
functions to rename and/or import interaction functions.

Importing constraints

• Added import_constraints( )
  Reads constraints from an python file and adds them to the model.
  For details check the
  docs.

In some circumstances, the parameter fitted in an optimization run are not
independent of each other. I.e. one might want to enforce that sum of two
parameters is always equal to one. Such a behavior is enforced through
'constraints'.

Documentation

• Hosted the current drafts of the documentation on readthedocs.io.
• Documentation created via sphinx
• Added automated API reference creation based on docstrings via autodoc