Learning ESCAPE
----------------

Intro
++++++++

The official documentation for ESCAPE modules lives `here <contents.html>`_.
 
If you don't have background on the Python language, you might be interested in these tutorials:

- `The Official Python Tutorial <http://docs.python.org/tutorial/>`_
- `Learn Python in 10 minutes <https://www.stavros.io/tutorials/python/>`_
- `Learn Python the hard way <http://learnpythonthehardway.org/>`_

Despite the fact that ESCAPE can be used in python command line directly, we recommend to start with `Jupyter project <https://jupyter.org/>`_,
particularly with Jupyter notebooks.

We encourage you to start learning ESCAPE with our list of example notebooks. The core notebooks briefly explain the philosophy of the project,
and give an overview about key entities and features.

The scattering notebooks povide an introduction to scattering applications currently covered by ESCAPE.
We update and improve example notebooks continuously. 

You can download all available notebooks from our repository:
`https://gitlab.com/escape-projects/escape-notebooks <https://gitlab.com/escape-projects/escape-notebooks/-/archive/master/escape-notebooks-master.zip>`_.


Example Notebooks
+++++++++++++++++++ 


.. toctree::
   :maxdepth: 2
   :caption:  Core notebooks:

   rst/notebooks/core/arrays_and_data
   rst/notebooks/core/cluster_kernel
   rst/notebooks/core/functors
   rst/notebooks/core/gamma
   rst/notebooks/core/linterp
   rst/notebooks/core/models
   rst/notebooks/core/regressor
   rst/notebooks/core/integration
   rst/notebooks/core/parameters
    
   

.. toctree::
   :maxdepth: 2
   :caption:  Scattering notebooks:

   rst/notebooks/scattering/StandingNWaves/standing_waves
   rst/notebooks/scattering/HighResXDiffrac/GaAs_AlAs_x20_GaAs/notebook
   rst/notebooks/scattering/SpecXRefl/CondensMatter/CuNi_Nb_Si/notebook
   rst/notebooks/scattering/mdb
   rst/notebooks/scattering/materials
   rst/notebooks/scattering/SpecNRefl/CondensMatter/Fe_Si/notebook
   rst/notebooks/scattering/SpecNRefl/CondensMatter/NonColWaveGuide/notebook
   rst/notebooks/scattering/SAXS/CondensMatter/SilicaBimodalNanoparticles/notebook
   rst/notebooks/scattering/SAXS/CondensMatter/GoldNanoparticles/notebook
   rst/notebooks/scattering/General/SAS/coreshell
   rst/notebooks/scattering/General/SAS/cylinder
   rst/notebooks/scattering/General/SAS/oblatecoreshell
   rst/notebooks/scattering/General/SAS/polycoreshell
   rst/notebooks/scattering/General/SAS/polyrectsphere
   rst/notebooks/scattering/General/SAS/sphere
   rst/notebooks/scattering/General/SAS/superball
   rst/notebooks/scattering/General/SAS/hollowcylinder
   rst/notebooks/scattering/SAXS/SoftMatter/branched_polymer
   rst/notebooks/scattering/SpecXRefl/CondensMatter/Nb_Gd_Nb_Al2O3/notebook
   rst/notebooks/scattering/SpecXRefl/CondensMatter/Ni_Si_Parratt32/notebook