.. _how_to_guides:

How-to Guides
=============

How-to guides provide detailed information about **respy**'s functionalities.
Refer to these guides if you are already familiar with EKW models aim to learn more
about implementing and estimating your own model with **respy**.

.. raw:: html

    <h2>Model Implementation</h2>

    <div class="container" class="index-container">
        <div class="row">
            <div class="col-lg-4 col-md-4 col-sm-4 col-xs-12">
                <a href="how_to_specify_model.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Specifying a Model</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Learn how to translate a model from equations
                                    to the <span><code class="docutils literal notranslate"><span class="pre">params</span></code> and <code class="docutils literal notranslate"><span class="pre">options</span></code>.</span>
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-4 col-md-4 col-sm-4 col-xs-12">
                <a href="how_to_example_models.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Loading Example Models</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Access pre-defined toy examples and published
                                    models. 
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-4 col-md-4 col-sm-4 col-xs-12">
                <a href="how_to_simulation.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Simulation</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    This guide contains a comprehensive overview
                                    of simulation capabilities.
                            </p>
                        </div>
                    </div>
                </a>
            </div>
        </div>
    </div>

    <h2>Model Extensions</h2>

    <div class="container" class="index-container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_finite_mixture.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Unobeserved Hetereogeneity</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Learn how to implement finite mixture models
                                    to account for unobserved heterogeneity.
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_initial_conditions.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Initial Conditions</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Add observable heterogeneity like experience,
                                    observable characteritics, and lagged choices
                                    to your model.
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_covariates.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Covariates</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Use Covariates to define complex payoff
                                    structures.
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_hyperbolic_discounting.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Hyperbolic Discounting</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Learn how to implement hyperbolic discounting
                                    in your model.
                            </p>
                        </div>
                    </div>
                </a>
            </div>
        </div>
    </div>

    <h2>Model Calibration</h2>

    <div class="container" class="index-container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_likelihood.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Maximum Likelihood</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Learn how to construct a criterion function for maximum
                                    likelihood estimation.
                            </p>
                        </div>
                    </div>
                </a>
            </div>
            
           <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_msm.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Method of Simulated Moments</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Construct a criterion function for estimation using
                                    the method of simulated moments.
                            </p>
                        </div>
                    </div>
                </a>
            </div>

            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_msm_estimation_exercise.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Estimation Exercise MSM</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    This guide contains an example of method of simulated
                                    moments estimation using estimagic.
                            </p>
                        </div>
                    </div>
                </a>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12">
                <a href="how_to_numerical_integration.html" class="index-link">
                    <div class="card text-center shadow h-100">
                        <div class="card-header">Numerical Integration</div>
                            <div class="card-body flex-fill">
                                <p class="card-text">
                                    Learn how to adjust the numerical integration
                                    in the model.
                            </p>
                        </div>
                    </div>
                </a>
            </div>
        </div>
    </div>


.. toctree::
    :hidden:
    :maxdepth: 1

    how_to_specify_model
    how_to_example_models
    how_to_simulation
    how_to_finite_mixture
    how_to_initial_conditions
    how_to_covariates
    how_to_hyperbolic_discounting
    how_to_numerical_integration
    how_to_likelihood
    how_to_msm
    how_to_msm_estimation_exercise