.. _tutorials:

Tutorials
=========

This section contains tutorials to help you get started with **cvxlab**. Each 
tutorial is designed to walks you through the steps described in the 
:ref:`User Guide <user_guide>` for different use-cases listed below.

Tutorial directories (with supplementary modeling materials such as Jupyter 
Notebooks, Excel concept files, input-data files and SQLite databases) can be 
downloaded from the table below, so that you can run them locally on your machine.


.. list-table:: CVXlab tutorials
    :header-rows: 1
    :widths: 30 68

    * - Tutorial
      - Description
    * - :ref:`Simplified energy system <tutorial-simple-energy-system>`
      - Complete workflow for defining and running a least-cost energy planning 
        model, aligned with the :ref:`User Guide <model_generation_from_scratch>`
        steps. *Ideal for newbies*.
    * - :doc:`Production planning <tutorials/production_planning/production_planning>`
      - A simple optimization problem related to production optimization under 
        resource constraints. Available as a Jupyter Notebook, which can be run 
        interactively.
        Full tutorial materials here: 
        :download:`Production Planning <tutorials/production_planning/production_planning.zip>`


.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Tutorials index

   tutorials/simple_energy_model/simple_energy_model
   tutorials/production_planning/production_planning.ipynb