Metadata-Version: 2.4
Name: wofryimpl
Version: 1.0.38
Summary: WOFRY (Wave Optics FRamework in pYthon) standard implementation
Author-email: Manuel Sanchez del Rio <srio@esrf.eu>, Luca Rebuffi <lrebuffi@anl.gov>
Maintainer-email: Manuel Sanchez del Rio <srio@esrf.eu>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/oasys-kit/wofryimpl
Project-URL: Download, https://github.com/oasys-kit/wofryimpl
Keywords: dictionary,glossary,synchrotron,simulation
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: wofry>=1.0.36
Requires-Dist: pySRU>=0.5.5
Requires-Dist: oasys-barc4ro>=2026.7.16
Requires-Dist: dabax
Requires-Dist: numba
Dynamic: license-file

wofryimpl
=========

WOFRYIMPL is the standard implementation of the `wofry <https://github.com/oasys-kit/wofry>`_ library.
It contains models and algorithms implementing the physics of wavefronts, beamline elements and
free-space propagators.

WOFRYIMPL is used by `OASYS2-WOFRY <https://github.com/oasys-kit/OASYS2-WOFRY>`_ inside the
`OASYS <https://oasys-kit.github.io/>`_ environment for visual beamline simulations.
It can also be used standalone to run scripts generated by OASYS-WOFRY.

A description of the methods implemented in WOFRYIMPL can be found in:

Manuel Sanchez del Rio, Juan Reyes-Herrera, Rafael Celestre, Luca Rebuffi
"WOFRY: a package for partially coherent beamline simulations in fourth-generation storage rings"
https://doi.org/10.48550/arXiv.2410.01338

Installation
------------

.. code-block:: bash

   pip install wofryimpl

or from source::

   git clone https://github.com/oasys-kit/wofryimpl
   cd wofryimpl
   pip install -e .

Documentation
-------------

https://wofryimpl.readthedocs.io/

Source
------

https://github.com/oasys-kit/wofryimpl
