:py:mod:`respy.interface`
=========================

.. py:module:: respy.interface

.. autoapi-nested-parse::

   General interface functions for respy.

   ..
       !! processed by numpydoc !!


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   respy.interface.get_example_model
   respy.interface.get_parameter_constraints



Attributes
~~~~~~~~~~

.. autoapisummary::

   respy.interface.KW_94_CONSTRAINTS
   respy.interface.KW_97_BASIC_CONSTRAINTS
   respy.interface.KW_97_EXTENDED_CONSTRAINTS
   respy.interface.KW_2000_CONSTRAINTS
   respy.interface.ROBINSON_CRUSOE_CONSTRAINTS


.. py:data:: KW_94_CONSTRAINTS
   

   

.. py:data:: KW_97_BASIC_CONSTRAINTS
   

   

.. py:data:: KW_97_EXTENDED_CONSTRAINTS
   

   

.. py:data:: KW_2000_CONSTRAINTS
   

   

.. py:data:: ROBINSON_CRUSOE_CONSTRAINTS
   

   

.. py:function:: get_example_model(model, with_data=True)

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


   :Parameters:

       **model** : :class:`python:str`
           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_data** : :ref:`bool <python:bltin-boolean-values>`
           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.














   ..
       !! processed by numpydoc !!

.. py:function:: get_parameter_constraints(model)

   
   Get parameter constraints for the estimation compatible with estimagic.

   For more information, see the `documentation of estimagic
   <https://estimagic.readthedocs.io/en/latest/optimization/constraints/
   constraints.html>`_.

   :Parameters:

       **model** : :class:`python:str`
           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:

       **constraints** : :class:`python:list`\[:class:`python:dict`\[:class:`python:str`, :class:`python:str`]]
           A list of dictionaries specifying constraints.










   .. rubric:: Examples

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



   ..
       !! processed by numpydoc !!