Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
GraxPy documentation
GraxPy logo
GraxPy documentation
Version 0.5.7

User guide

  • Installation
    • Web UI
  • Validation
    • Blazed Grating
    • Blazed Multilayer Grating
    • Laminar Grating (400 l/mm, fixed angle)
    • Laminar Grating (150 l/mm, monochromator sweep)
    • RCWA vs Nevière differential method
  • Tutorials
    • Materials
    • Gratings
      • Laminar Gratings
      • Sinusoidal Gratings
      • Blazed Gratings
      • Blazed Multilayer With Custom Stack
      • AFM Preprocessing to ProfileGrating
    • Simulations
      • Single simulation
      • Batch simulations
        • Multiprocessing
        • Checkpoints and resume
      • Sweep Recipes
        • Fixed-angle energy sweep
        • Roughness
        • Monochromator sweep
        • Energy-angle sweep (Multilayer)
        • Multilayer theta search
        • Multilayer grating design workflow
        • Parameter study
      • Roughness
      • User-defined cases
      • Export And Plot Results
    • Choosing a solver
    • Where the two solvers differ
    • Acceleration Backend
      • Backend Selection And NumPy Deprecation
      • Reproduce Speed Benchmarks
    • Optimizer
      • Laminar Grating
      • Blazed Grating
      • Joint measurement fits
      • Resume an optimizer run
  • How-To Guides
    • Create Custom Grating Profiles
    • How To Run User-Defined Case Lists

Reference

  • API reference
    • Gratings
    • Simulation
      • Package organization
      • Single simulation
      • Batch runner
      • Fixed-angle sweep
      • Monochromator sweep
      • Energy-angle sweep
      • Multilayer theta search
      • Multilayer grating design
      • Parameter study
    • Optimization API (grax_opt)
    • Planar mirrors (grax.planar_mirror)
Back to top
View this page

API reference¶

This section documents the supported public API for the core GraxPy simulation package. Lower-level numerical infrastructure and experimental helpers are intentionally left out of the user-facing API reference.

  • Gratings
  • Simulation
  • Optimization API (grax_opt)
  • Planar mirrors (grax.planar_mirror)
Next
Gratings
Previous
How To Run User-Defined Case Lists
Copyright © 2026, GraxPy contributors
Made with Sphinx and @pradyunsg's Furo