.. index:: How To's

.. |binder| image::
      images/mybinder.png
      :target: https://mybinder.org/v2/gh/SModelS/smodels/main?filepath=docs%2Fmanual%2Fsource%2Frecipes%2F


.. _Examples:

How To's
========



Below we provide a few examples for using SModelS and some of the :ref:`SModelS tools <smodelsTools>` as a Python library [1]_.


To try out the examples in interactive mode: |binder|
-----------------------------------------------------

Main examples:
--------------

* `How to run SModelS using a parameter file <runWithParameterFile.html>`_ (download the Python code :download:`here <recipes/runWithParameterFile.py>`, IPython notebook :download:`here <recipes/runWithParameterFile.ipynb>`)

* `How to run SModelS as a python library <runAsLibrary.html>`_ (download the Python code :download:`here <recipes/runAsLibrary.py>`, IPython notebook :download:`here <recipes/runAsLibrary.ipynb>`)

Examples displaying several functionalities:
--------------------------------------------

* `How to load the database <load_database.html>`_ (download the Python code :download:`here <recipes/load_database.py>`, IPython notebook :download:`here <recipes/load_database.ipynb>`)

* `How to obtain experimental upper limits <lookup_upper_limit.html>`_ (download the Python code :download:`here <recipes/lookup_upper_limit.py>`, IPython notebook :download:`here <recipes/lookup_upper_limit.ipynb>`)

* `How to obtain experimental efficiencies <lookup_efficiency.html>`_ (download the Python code :download:`here <recipes/lookup_efficiency.py>`, IPython notebook :download:`here <recipes/lookup_efficiency.ipynb>`)

* `How to print decomposition results <print_decomposition.html>`_ (download the Python code :download:`here <recipes/print_decomposition.py>`, IPython notebook :download:`here <recipes/print_decomposition.ipynb>`)

* `How to print theory predictions <print_theoryPrediction.html>`_ (download the Python code :download:`here <recipes/print_theoryPrediction.py>`, IPython notebook :download:`here <recipes/print_theoryPrediction.ipynb>`)

* `How to compare theory predictions with experimental limits <compareUL.html>`_ (download the Python code :download:`here <recipes/compareUL.py>`, IPython notebook :download:`here <recipes/compareUL.ipynb>`)

* `How to draw SMS graphs <drawingGraphs.html>`_ (download the Python code :download:`here <recipes/drawingGraphs.py>`, IPython notebook :download:`here <recipes/drawingGraphs.ipynb>`)

* `How to use a LHE input including width information <lheLLPExample.html>`_ (download the Python code :download:`here <recipes/lheLLPExample.py>`, IPython notebook :download:`here <recipes/lheLLPExample.ipynb>`)

* `How to compute the likelihood and chi2 for a theory predictions <compute_likelihood.html>`_ (download the Python code :download:`here <recipes/compute_likelihood.py>`, IPython notebook :download:`here <recipes/compute_likelihood.ipynb>`)

* `How to find missing topologies <missingTopologies.html>`_ (download the Python code :download:`here <recipes/missingTopologies.py>`, IPython notebook :download:`here <recipes/missingTopologies.ipynb>`)

* `How to generate ascii graphs <ascii_graph_from_lhe.html>`_ (download the Python code :download:`here <recipes/ascii_graph_from_lhe.py>`, IPython notebook :download:`here <recipes/ascii_graph_from_lhe.ipynb>`)

* `How to plot likelihoods from analysis combinations <plotCombinedLikelihood.html>`_ (download the Python code :download:`here <recipes/plotCombinedLikelihood.py>`, IPython notebook :download:`here <recipes/plotCombinedLikelihood.ipynb>`)

* `How to use a combinations matrix <combinationsmatrix.html>`_ (download the Python code :download:`here <recipes/combinationsmatrix.py>`, IPython notebook :download:`here <recipes/combinationsmatrix.ipynb>`)

Examples using the cross-section computer:
------------------------------------------

* `How to compute leading order cross sections (for MSSM) <lo_xsecs_from_slha.html>`_ (download the Python code :download:`here <recipes/lo_xsecs_from_slha.py>`, IPython notebook :download:`here <recipes/lo_xsecs_from_slha.ipynb>`)

* `How to compute next-to-leading order cross sections (for MSSM) <nll_xsecs_from_slha.html>`_ (download the Python code :download:`here <recipes/nll_xsecs_from_slha.py>`, IPython notebook :download:`here <recipes/nll_xsecs_from_slha.ipynb>`)

Examples using the Database Browser
-----------------------------------

* `How to obtain upper limits <browserExample2.html>`_ (download the Python code :download:`here <recipes/browserExample2.py>`, IPython notebook :download:`here <recipes/browserExample2.ipynb>`)

* `How to select specific results <browserExample3.html>`_ (download the Python code :download:`here <recipes/browserExample3.py>`, IPython notebook :download:`here <recipes/browserExample3.ipynb>`)

Examples using the Interactive Plots tool
-----------------------------------------

* `How to make interactive plots <interactivePlotsExample.html>`_ (download the Python code :download:`here <recipes/interactivePlotsExample.py>`, IPython notebook :download:`here <recipes/interactivePlotsExample.ipynb>`)


.. [1] Some of the output may change depending on the database version used.