Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

SHADOW is an open source ray tracing code for modeling optical systems.

Project Description
--------------------------------------------------------------------------------
SHADOW 3.0 SOURCE DISTRIBUTION
--------------------------------------------------------------------------------


Contents:


1 What is SHADOW
2 Download
3 Source files
4 Building SHADOW
5 Other info
6 Contact

--------------------------------------------------------------------------------
1 What is SHADOW
----------------

SHADOW is an open source ray tracing code for modeling optical systems.

Targeted to synchrotron radiation beamlines, it has unique features for
designing X-ray optical systems.

For more info, please read this paper (open access):

SHADOW3: a new version of the synchrotron X-ray optics modelling package
M. Sanchez del Rio, N. Canestrari, F. Jiang and F. Cerrina
Journal of Synchrotron Radiation Volume 18, Part 5 (September 2011)
http://dx.doi.org/10.1107/S0909049511026306

2 Download
----------

SHADOW3 sources are downloaded using git:

since 2015-10-16 the master shadow3 git repository is at github.com:

git clone https://github.com/srio/shadow3

however, the original repository at the EPN-campus is maintained, and
will be kept updated, from time to time:

git clone git://git.epn-campus.eu/repositories/shadow3

Other SHADOW web resources:

shadow3 binary distributions (not updated):
shadow3: ftp://ftp.esrf.fr/pub/scisoft/shadow3/
shadow2: ftp://ftp.esrf.fr/pub/scisoft/shadow/ ( - obsoleted - )

Documentation:
Shadow Primer (for using shadow3 in command mode)
http://forge.epn-campus.eu/attachments/996/Shadow3Primer.pdf

SHADOW user interfaces:
ShadowOui:
Pretty fancy and new interface under python/oasys:
https://www.elettra.trieste.it/lightsources/labs-and-services/hard-x-ray-techniques-laboratory/oasys.html
http://ftp.esrf.eu/pub/scisoft/Oasys/

ShadowVui:
The traditional IDL-based interface working under XOP 2.4 and 2.3
xop2.4: https://www1.aps.anl.gov/Science/Scientific-Software/XOP
xop2.3: ftp://ftp.esrf.fr/pub/scisoft/xop2.3/

Official reference:
http://dx.doi.org/10.1107/S0909049511026306


3 Important files
-----------------

in shadow3/src: fortran, c and other sources
in Shadow: python sources

in docs: README files:
README_API.txt
README_CRL.txt
README_MPI.txt
README_PYTHON.txt
source.nml (description of the source variables, as in start.00)
oe.nml (description of the optical element variables, as in start.01)

in data: data files:
PRELIB1.DAT and PRELIB2.DAT (data file containg the oprical library)

4 Building SHADOW
----------------
binary:
cd src
Check (edit) the Makefile if you need to redefine compilers etc.
The use of Makefile is documented in its header. Basically:
make : builds shadow3 the main program
make all : builds shadow3, libraries, etc
make install : installation (see Makefile)

python API:
in shadow3 directory, use the standard python setup:

python3 setup.py build
sudo python3 setup.py install


5 Other info
------------

6 Contact
---------

SHADOW is currently maintained by Manuel Sanchez del Rio (srio@esrf.eu)
Release History

Release History

This version
History Node

20160729.224338

History Node

20160725.222322

History Node

20160725.221708

History Node

20160709.140033

History Node

20160709.123758

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
shadow3-20160729.224338.zip (592.4 kB) Copy SHA256 Checksum SHA256 Source Jul 29, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting