Metadata-Version: 2.1
Name: shadow4
Version: 0.1.60
Summary: shadow implementation in python
Home-page: https://github.com/oasys-kit/shadow4/
Download-URL: https://github.com/oasys-kit/shadow4/
Author: Manuel Sanchez del Rio, Luca Rebuffi
Author-email: srio@esrf.eu
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: setuptools
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: syned>=1.0.41
Requires-Dist: srxraylib>=1.0.61
Requires-Dist: crystalpy>=0.0.25

=======
shadow4
=======

About
-----

Ray tracing package for optical systems targeted for x-ray and synchrotron optics.

Documentation
-------------
https://shadow4.readthedocs.io/


Source repository
-----------------
https://github.com/oasys-kit/shadow4

Quick-installation
------------------

Shadow4 can be installed with Python 3.x:

.. code-block:: console

    $ python -m pip install shadow4

Graphical user interface
------------------------

A graphical interface is available under Oasys:  https://github.com/oasys-kit/OASYS1-shadow4

References
----------

To cite shadow4, please use:

Manuel Sanchez del Rio et al 2025 J. Phys.: Conf. Ser. 3010 012071
https://doi.org/10.1088/1742-6596/3010/1/012071

Other notes or papers with methods and algorithms related to SHADOW4 are: 

* Modelling undulators in ray tracing simulations http://dx.doi.org/10.1107/S1600577525000190
* Ray tracing simulations of bending magnet sources with SHADOW4 https://doi.org/10.48550/arXiv.2406.16446
* Conic Surfaces and Transformations for X-Ray Beamline Optics Modeling https://doi.org/10.48550/arXiv.2406.04079
* Equations and models used for crystals http://dx.doi.org/10.1107/S160057752400924X


