Examples
========
.. _examples:

In addition to the examples listed here, you can find further detailed examples which use both
RayFlare and Solcore (our integrated solar cell modelling package which also includes device physics
models) on the `solcore-education`_ page.

Structures using a single simulation method per structure
----------------------------------------------------------

These examples do not use the angular redistribution matrix method; the whole structure to be simulated
is treated with the same optical method (ray-tracing, TMM or RCWA). The final example shows how to do a ray-tracing
simulations of a perovskite-Si tandem solar cell, using TMM to calculate reflection at the interfaces (but without using
the angular redistribution matrix method).

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   rcwa_examples.ipynb
   rcwa_tmm_validation.ipynb
   rt_pyramids.ipynb
   create_rt_texture.ipynb
   perovskite_Si_rt.ipynb


Using the angular matrix method
--------------------------------

These examples demonstrate the angular matrix method, where the front and back surfaces of the
structure are treated separately and can be simulated with different methods.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   grating_pyramids_OPTOS.ipynb
   compare_models_3Jsolarcell.ipynb
   compare_models_3Jsolarcell_profile.ipynb
   HIT_emissivity.ipynb

Full list of GitHub examples
-----------------------------

These examples are available in the `GitHub repository <https://github.com/qpv-research-group/rayflare/tree/devel/examples>`_; a list
is provided here to give an overview of what is covered in each example.

Multiple methods
##################

1. compare_models_3Jsolarcell.py
2. compare_models_3Jsolarcell_profile.py

Ray-tracing
#############

1. rt_pyramids:
2. create_rt_texture:
3. analytical_rt_comparison

RCWA
######

1. aSi_pillar_grating
2.

.. _solcore-education: https://qpv-research-group.github.io/solcore-education/solcore-workshop-2/schedule.html