Welcome

Open-source, integrated optical modelling of complex stacks. The aim of RayFlare is to provide a flexible, user-friendly Python environment to model complex optical stacks, with a focus on solar cells. If you want to read more about the optical models behind RayFlare, you can do that here or get started by looking at some examples.

Check the news & updates page for recent changes and new functionality.

If you want to be notified about new RayFlare & Solcore releases, please join our mailing list (this will be at most a few emails per year, we will not spam you!).

If you use RayFlare in your work, please cite the JOSS paper:

Pearce, P. M., (2021). RayFlare: flexible optical modelling of solar cells. Journal of Open Source Software, 6(65), 3460. https://doi.org/10.21105/joss.03460

Contents:

• News & Updates
  • Version 2.0 released (2024-09-23)
  • Version 1.2.1 released (2023-11-19)
  • Version 1.2.0 released (2023-03-21)
• Installation instructions
  • Python versions and installing Python3.10
  • Setting up to install S4 on Ubuntu
  • Setting up to install S4 on MacOS
  • Installing S4 (Ubuntu and MacOS)
  • Installing RayFlare
  • Updating RayFlare
  • Setting things up to use/develop
  • Installing S4 on Windows
  • Troubleshooting
• Overview & background
• Examples
  • Structures using a single simulation method per structure
  • Using the angular matrix method
  • Full list of GitHub examples
• Angular redistribution matrix method
  • Individual function documentation:
• Ray-tracing
  • Analytical ray-tracing
  • Treatment of polarization
  • Individual function documentation:
• Transfer-matrix method
  • Individual function documentation:
• Rigorous coupled-wave analysis
  • Individual function documentation:
• Textures
  • Individual function documentation:
• Analytical calculations
  • Individual function documentation:
• Options
  • Performance
  • General options/options for matrix framework
  • Options used only by RCWA (S4)
  • Options used only by the ray-tracer
  • Options used only by the TMM
• Utility functions
  • Individual function documentation:

Indices and tables

• Index

• Module Index

• Search Page