Skip to content

Commit

Permalink
for release 1.3.0 (2)
Browse files Browse the repository at this point in the history
  • Loading branch information
kklmn committed Mar 25, 2018
1 parent 62267a7 commit 2f41c1a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 12 deletions.
47 changes: 37 additions & 10 deletions PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Metadata-Version: 1.1
Name: xrt
Version: 1.2.4
Summary: Ray tracing and wave propagation in x-ray regime, primarily meant for modeling synchrotron sources, beamlines and beamline elements. Includes a GUI tool for creating scripts.
Home-page: http://pythonhosted.org/xrt
Version: 1.3.0
Summary: Ray tracing and wave propagation in x-ray regime, primarily meant for modeling synchrotron sources, beamlines and beamline elements. Includes a GUI for creating a beamline and viewing it in 3D.
Home-page: http://xrt.readthedocs.io
Author: Konstantin Klementiev, Roman Chernikov
Author-email: konstantin DOT klementiev AT gmail DOT com, rchernikov AT gmail DOT com
Author-email: konstantin.klementiev@gmail.com, rchernikov@gmail.com
License: MIT License
Description:
Package xrt (XRayTracer) is a python software library for ray tracing and wave
propagation in x-ray regime. It is primarily meant for modeling synchrotron
sources, beamlines and beamline elements. Includes a GUI tool for creating
scripts.
sources, beamlines and beamline elements. Includes a GUI for creating a
beamline and interactively viewing it in 3D.

Features of xrt
---------------
Expand Down Expand Up @@ -119,6 +119,7 @@ Description:

xrtQook -- a GUI for creating scripts
-------------------------------------

The main interface to xrt is through a python script. Many examples of such
scripts can be found in the supplied folder 'examples'. The script imports the
modules of xrt, instantiates beamline parts, such as synchrotron or geometric
Expand All @@ -133,17 +134,43 @@ Description:
also including those from the parental classes. xrtQook writes/reads the
recipes of beamlines into/from xml files.

xrtGlow -- an interactive 3D beamline viewer
--------------------------------------------

The beamline created in xrtQook can be interactively viewed in an OpenGL based
widget xrtGlow. It visualizes beams, footprints, surfaces, apertures and
screens. The brightness represents intensity and the color represents an
auxiliary user-selected distribution, typically energy. A virtual screen can be
put at any position and dragged by mouse with simultaneous observation of the
beam distribution on it.

The primary purpose of xrtGlow is to demonstrate the alignment correctness
given the fact that xrtQook can automatically calculate several positional and
angular parameters.

Dependencies
------------
numpy, scipy matplotlib are required. If you use OpenCL for calculations on GPU
or CPU, you need AMD/NVIDIA drivers, ``Intel CPU only OpenCL runtime`` (these
are search key words), pytools and pyopencl. Spyderlib (the foundation of
Spyder IDE) is highly recommended for nicer view of xrtQook.

numpy, scipy and matplotlib are required. If you use OpenCL for calculations on
GPU or CPU, you need AMD/NVIDIA drivers, ``Intel CPU only OpenCL runtime``
(these are search key words), pytools and pyopencl. PyQt4 or PyQt5 are needed
for xrtQook. Spyder (as library of Spyder IDE) is highly recommended for nicer
view of xrtQook. OpenGL is required for xrtGlow.

Python 2 and 3
--------------
The code can run in both Python branches without any modification.

Get xrt
-------
xrt is available as source distribution from `pypi.python.org
<https://pypi.python.org/pypi/xrt>`_ and from `GitHub
<https://github.com/kklmn/xrt>`_. The distribution archive also includes tests,
and examples. The complete documentation is available at
`Read the Docs <http://xrt.readthedocs.io>`_ and as zip file from
`GitHub <https://github.com/kklmn/xrt>`_ .


Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,7 @@
'and viewing it in 3D.',
long_description=long_description,
author='Konstantin Klementiev, Roman Chernikov',
author_email='konstantin DOT klementiev AT gmail DOT com, '
'rchernikov AT gmail DOT com',
author_email='[email protected], [email protected]',
url='http://xrt.readthedocs.io',
platforms='OS Independent',
license='MIT License',
Expand Down

0 comments on commit 2f41c1a

Please sign in to comment.