Tutorials and Examples
======================


PARETO currently has the following Jupyter notebook demonstrations available:

#. `Strategic model demo <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/strategic_model_general_demo/strategic_model_general_demo.ipynb>`_

#. `Strategic model - treatment module and sensitivity analysis demo <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/strategic_model_treatment_module_demo/strategic_model_treatment_module_demo.ipynb>`_

#. Desalination notebooks

    * `Membrane distillation flowsheet <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/desalination_jupyter_notebooks/MD_PARETO.ipynb>`_

    * `Mechanical vapor recompression model <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/desalination_jupyter_notebooks/mee_mvr_jupyter_notebook.ipynb>`_

    * `Integrated desalination models - membrane distillation <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/desalination_jupyter_notebooks/integrated_optimization_md_jupyter_notebook.ipynb>`_

    * `Integrated desalination models - mechanical vapor recompression <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/desalination_jupyter_notebooks/integrated_optimization_mvr_jupyter_notebook.ipynb>`_

    * `Desalination surrogate model training <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/desalination_jupyter_notebooks/desalination_surrogate_training.ipynb>`_

#. `Subsurface risk and multi-objective optimization <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/multiobjective_optimization/seismicity_vs_cost_MOO.ipynb>`_

#. `Critical minerals screening tool <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/CM_screening_tool/CM_screening_tool.ipynb>`_

#. Visualization utility demonstrations:

    * `Bar charts <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/visualization_demos/plot_bars_demo.ipynb>`_

    * `Scatter plots <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/visualization_demos/plot_scatter_demo.ipynb>`_

    * `Sankey diagrams <https://github.com/project-pareto/project-pareto/blob/main/pareto/examples/visualization_demos/plot_sankey_demo.ipynb>`_

Users interested in utilizing PARETO programmatically by writing Python code can download and run these Jupyter notebooks. Additional Jupyter notebook tutorials and examples are currently under development and will be added to the `examples directory <https://github.com/project-pareto/project-pareto/tree/main/pareto/examples>`_ of the PARETO repository when they are available. The above list will be updated as well.

PARETO is an open source project in collaboration with the `IDAES <https://idaes-pse.readthedocs.io/en/latest/>`_ and `WaterTAP <https://watertap.readthedocs.io/en/latest/>`_ projects. As such, the `IDAES tutorials <https://idaes-pse.readthedocs.io/en/latest/tutorials/tutorials_examples.html>`_ and `WaterTAP tutorials <https://watertap.readthedocs.io/en/latest/tutorials/index.html>`_ are good ancillary learning materials.

New users of PARETO will also benefit from familiarity with Python and Pyomo. PARETO, IDAES, and WaterTAP are all built with Python and Pyomo, so we refer users unfamiliar with Python or Pyomo to the following tutorials:

* `Short Introduction to Python and Pyomo <https://idaes.github.io/examples-pse/latest/Tutorials/Basics/introduction_short_solution_doc.html>`_

* `Longer Introduction to Python and Pyomo <https://idaes.github.io/examples-pse/latest/Tutorials/Basics/introduction_solution_doc.html>`_