Welcome

Welcome to Raysect, an OOP ray-tracing framework for Python. Raysect has been built with scientific ray-tracing in mind. Some of its features include:

• Fully spectral, high precision. Supports scientific ray-tracing of spectra from physical light sources such as plasmas.
• All core loops are written in cython for speed.
• Easily extensible, written with user customisation of materials and emissive sources in mind.
• Different observer types supported such as Pinhole cameras and optical fibres.

Quick Installation

The easiest way to install Raysect is using pip:

pip install raysect

For more detailed installation instructions see Downloading and Installation.

Table of Contents

• 1. Introduction
• 2. Downloading and Installation
  • 2.1. Prerequisites
  • 2.2. Installation
  • 2.3. Testing
• 3. How it works
  • 3.1. What is a ray tracer?
  • 3.2. Key Concepts
  • 3.3. Process of raytracing
• 4. Quickstart Guide
  • 4.1. Create Primitives
  • 4.2. Add Observer
  • 4.3. Build Scenegraph
  • 4.4. Observe()
  • 4.5. Simulated Spectrum
• 5. Primitives
  • 5.1. Geometric Primitives
  • 5.2. CSG Operations
  • 5.3. Meshes
• 6. Materials
• 7. Conventions
• 8. License
• 9. Need Help?

Demonstrations

• 1. Core Functionality
• 2. Examples Gallery

API Reference

• 1. Raysect Core
  • 1.1. Core Classes
  • 1.2. Math Module
    • 1.2.1. Points and Vectors
    • 1.2.2. Affine Matricies
    • 1.2.3. Functions and Interpolators
    • 1.2.4. Random
    • 1.2.5. Unit Conversions
  • 1.3. Scenegraph Module
  • 1.4. Utilities
    • 1.4.1. Containers
• 2. Primitives Module
  • 2.1. Geometric Primitives
  • 2.2. Meshes
  • 2.3. CSG Operations
• 3. Optical Module
  • 3.1. Main Optical Classes
  • 3.2. Observers
  • 3.3. Optical Materials

Indices and Tables

• Index
• Module Index
• Search Page