Welcome to raypyng’s documentation!

raypyng provides a simple python API to work with RAY-UI, a software for optical simulation of synchrotron beamlines and x-ray systems developed by Helmholtz-Zentrum Berlin.

Contents:

• Installation
  • Install RAY-UI
  • Install xvfb
  • Install raypyng
• Tutorial
  • Manipulate an RML file
  • RAY-UI API
  • Simulations
    • Perform Simulations
    • Simulation Output
  • Recipes
  • List of available examples
• How To Guides
  • Write your own Recipe
    • Recipe Template
    • How To Write a Recipe
  • How to work with Undulator File
• API
  • Simulation
    • Simulate
    • SimulationParams
    • WaveHelper
  • VLS Grating Coefficient Calculation
    • calculate_vls_coeff()
    • N1_to_b2()
    • cff_for_fixed_focus()
  • Recipes
    • Resolving Power
    • Flux
  • Process simulation files
    • PostProcess rays analyzed by raypyng
    • PostProcess rays analyzed by RAY-UI
    • RayProperties
  • RAY-UI API
    • RayUIRunner
    • RayUIAPI
  • RML
    • RMLFile
    • BeamlineElement
    • ObjectElement
    • ParamElement
  • Dipole
    • Dipole