`respy.interface`#

General interface functions for respy.

Module Contents#

`get_example_model`(model[, with_data])	Return parameters, options and data (optional) of an example model.
`get_parameter_constraints`(model)	Get parameter constraints for the estimation compatible with estimagic.

`KW_94_CONSTRAINTS`
`KW_97_BASIC_CONSTRAINTS`
`KW_97_EXTENDED_CONSTRAINTS`
`KW_2000_CONSTRAINTS`
`ROBINSON_CRUSOE_CONSTRAINTS`

respy.interface.get_example_model(model, with_data=True)[source]#

Return parameters, options and data (optional) of an example model.

Parameters:

modelstr: Choose one model name in {"robinson_crusoe_basic", "robinson_crusoe_extended", kw_94_one", "kw_94_two", "kw_94_three", "kw_97_basic", "kw_97_extended" "kw_2000"}.
with_databool: Whether the accompanying data set should be returned. For some data sets, real data can be provided, for others, a simulated data set will be produced.

respy.interface.get_parameter_constraints(model)[source]#

Get parameter constraints for the estimation compatible with estimagic.

For more information, see the documentation of estimagic.

Parameters:

modelstr: Choose one model name in {"robinson_crusoe_basic", "robinson_crusoe_extended", kw_94_one", "kw_94_two", "kw_94_three", "kw_97_basic", "kw_97_extended" "kw_2000"}.

Returns:

constraintslist[dict[str, str]]: A list of dictionaries specifying constraints.

Examples

>>> constr = rp.get_parameter_constraints("robinson_crusoe_basic")
>>> constr
[{'loc': 'shocks_sdcorr', 'type': 'sdcorr'}]