.. pyproject_example documentation master file, created by sphinx-quickstart on Mon Oct 3 16:16:30 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. 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_ .. toctree:: :hidden: Home page Installation Usage Example gallery API reference <_autosummary/pysrw> Installing the package and running your first simulation will only take a few minutes! Features ======== * |:snake:| quick way to setup SRW simulations in Python * |:video_game:| step by step :ref:`examples ` * |:books:| detailed :ref:`API documentation ` * |:hammer_and_wrench:| tools for wavefront manipulation and coherence computation * |:rocket:| multiprocessing features to speed up simulations on multi-core machines or clusters .. _documentation: https://github.com/ochubar/SRW 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 :ref:`section `.