-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
137 lines (103 loc) · 3.47 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
--------------------------------------------------------------------------------
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:
git clone git://git.epn-campus.eu/repositories/shadow3
Other SHADOW web resources:
http://forge.epn-campus.eu/projects/shadow3 (source repository)
http://forge.epn-campus.eu/attachments/996/Shadow3Primer.pdf (primer)
ftp://ftp.esrf.fr/pub/scisoft/shadow3/ (binary distribution)
ftp://ftp.esrf.fr/pub/scisoft/shadow/ (SHADOW2 distributions - obsoleted - )
ftp://ftp.esrf.fr/pub/scisoft/xop2.3/ (XOP and SHADOWVUI user interface)
http://dx.doi.org/10.1107/S0909049511026306 (Official reference)
3 Source files
--------------
After using "git clone git://git.epn-campus.eu/repositories/shadow3"
a single shadow3 directory is created. It contains all sources and resources tu build shadow3. The basic files are
Tools:
Makefile: makefile
Source files:
shadow_version.F90
shadow_globaldefinitions.F90
stringio.F90
gfile.F90
shadow_beamio.F90
shadow_math.F90
shadow_variables.F90
shadow_kernel.F90
shadow_synchrotron.F90
shadow_pre_sync.F90
shadow_preprocessors.F90
shadow_postprocessors.F90
shadow_bind_f.F90
shadow_crl.F90
cdf_z.f
wranc.c
Source file main shadow3 program:
shadow3.F90
Source file optional main programs (examples):
gen_source.F90
trace3.F90
trace3mpi.F90
trace.F90
example01_f95.F90
example02_f95.F90
Source file API (C/C++/PYTHON/IDL)
shadow_bind_idl.c
shadow_bind_idl_loader.c
shadow_bind_c.c
shadow_bind_python.c
setup.py
ShadowTools.py
ShadowToolsPrivate.py
setpythonpath.sh
Source file examples API (C/C++/PYTHON/IDL)
trace3_c.c
trace3_py.py
example01_c.c
example_shadow_format.c
example_tolerances.py
shadow_bind_idl_test.pro
README files:
README.txt (this file)
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)
Data files:
PRELIB1.DAT and PRELIB2.DAT (data file containg the oprical library)
Directories:
PRIMER_INPUT_FILES (script to run all the examples discussed in the Primer)
4 Building SHADOW
----------------
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, examples and API
5 Other info
------------
6 Contact
---------
SHADOW is currently maintained by Manuel Sanchez del Rio ([email protected])