Welcome to PySRW’s documentation!

Welcome to PySRW’s documentation!#

A Python package for Synchrotron Radiation Workshop simulations

Note

The content of this documentation is based on the authors’ personal experience. Any comment about SRW has not to be intended as a general statement about the original code. For a wider overview, please refer to the official SRW documentation

Installing the package and running your first simulation will only take a few minutes!

Features#

  • 🐍 quick way to setup SRW simulations in Python

  • 🎮 step by step examples

  • 📚 detailed API documentation

  • 🛠️ tools for wavefront manipulation and coherence computation

  • 🚀 multiprocessing features to speed up simulations on multi-core machines or clusters

Compatibility with srwlib#

If you require the full flexibility of the original SRW bindings, you can access all the objects of the srwlib from this module. The original documentation of srwlib is also included in the API reference under this section.