XOP Version 1.9 README File =========================== Contents: 0) What is XOP? 1) Requirements 2) UNIX Installation Notes 3) WINDOWS Installation Notes 4) Authors and Support 0) What is XOP? =============== XOP is a widget based interface which drives programs from different authors to calculate synchrotron radiation source spectra (bending magnet, wiggler and undulator), reflection and transmission characteristics of optical elements (mirrors, filters, flat crystals, bent perfect crystals, and multilayers). XOP also contains programs for multi-purpose data analysis and visualization. XOP and many of its applications are written in the Interactive Data Language (IDL). It also uses many binary modules developed in other languages, in particular FORTRAN. The interface largely simplifies the use of these applications and may be used without prior knowledge of how to run a particular program. It runs on most Unix machines and on Windows (Windows-95 and Windows-NT). XOP also includes a flexible DAta BAse for X-ray applications (DABAX), which is a compilation of tables for x-ray applications with codes to access, visualize and process these tables. XOP is distributed free of charge to research institutes and non-profit organizations. The necessary files can be downloaded from the anonymous ftp servers at the European Synchrotron Radiation Facility (ESRF), France and the Advanced Photon Source (APS), USA: ftp://ftp.esrf.fr/pub/expg/idl/xop (site in France) ftp://ftpa.aps.anl.gov/pub/xfd/idl/xop (site in USA) XOP is distributed free of charge but we ask the users to complete the on-line REGISTRATION_FORM and e-mail it to srio@esrf.fr and/or dejus@aps.anl.gov. An installation key is needed to decrypt one of the files and this key will be mailed to registred users only. 1.0) Requirements: ================== The current version of XOP runs on several UNIX machines and on Windows (Windows-95 and Windows-NT). The developments were made on the particular systems shown in parenthesis. UNIX: sun5: Solaris (SunOS 5.5.1) sun4: SunOS (SunOS 4.1.3) hp800: HP-UX-10 (HP-UX B.10.20 A 9000/821) (system 10 or newer) hp700: HP-UX A 9000/735 (system 10 or newer) linux: Linux (2.0.30 i686) irix: SGI (IRIX 6.3) WINDOWS: Windows-95 (developed on Windows-95) Windows-NT A UNIX machine or a reasonably powerful PC (e.g., Pentium 166MHz/32MB) is needed. It runs with only 16 MB of memory but a minimum of 32 MB is recommended for better performance. There are three run modes available: i) EMBEDDED Mode: Runtime version for any platform. Source codes are not available. ii) USER Mode: Requires a valid IDL license to run. Source codes are not available. iii) DEVELOPER Mode: Requires a valid IDL license to run. IDL source codes are available and may be changed by the user. The recommended installation is the EMBEDDED mode. The DEVELOPER mode is available for users who want to extend the XOP functionality. 2.1) UNIX Installation Notes (EMBEDDED mode, recommended): ========================================================== 1) create a directory for the installation (e.g., /users/me/xop ) 2) cd /users/me/xop 3) download the following files from one of the anonymous ftp sites xop_unpack xop1.9_common.tar.Z.encrypted xop1.9_data.tar.Z xop1.9_embedded_common.tar.Z xop1.9_embedded_.tar.Z xop1.9_bin_.tar.Z The is one of the following computer architectures: hp700, hp800, sun4, sun5, irix, or linux. A decrypting key is needed to complete the installation. The key will be e-mailed to registred users who have completed the on-line registration form (REGISTRATION_FORM) which should be sent to srio@esrf.fr or dejus@aps.anl.gov. Then either run the xop_unpack script or follow the instructions in the next paragraphs (for the xop_unpack script, go to item 8) 4) unpack the following files: crypt CRYPT_KEY < xop1.9_common.tar.Z.encrypted | zcat | tar xvf - zcat xop1.9_data.tar.Z | tar xvf - zcat xop1.9_embedded_common.tar.Z | tar xvf - zcat xop1.9_embedded_.tar.Z | tar xvf - zcat xop1.9_bin_.tar.Z | tar xvf - where "CRYPT_KEY" should be substituted by the corresponding key 5) customize the xop script file: set the XOP installation path (environment variable) XOP_HOME 6) test XOP by running the script ./xop. 7) cleanup: After a successful installation the *.Z files can be deleted. 8) create a soft link to /usr/local/bin/xop (needs root access) ln -s /users/me/xop/xop /usr/local/bin/xop or to your personal bin directory to facilitate the access to XOP. XOP can now be started by simply typing xop at the UNIX prompt. 9) add files to the dabax library by downloading them from: http://www.esrf.fr/computing/expg/subgroups/theory/DABAX/dabax.html (see the file $XOP_HOME/data/README.TXT for more details) 2.2) UNIX Installation Notes (USER mode): ========================================= 1) follow the same steps as in 2.1 above using the files: xop1.9_common.tar.Z.encrypted xop1.9_data.tar.Z xop1.9_user.tar.Z, xop1.9_bin_.tar.Z 2) customize the script file xop by defining the environmental variable XOP_HOME. The environmental variable IDL_DIR must be defined to point to the IDL installation. 3) start XOP in USER mode by using the -u switch, ./xop -u 2.3) UNIX Installation Notes (DEVELOPER mode): ============================================== 1) follow the same steps as in 2.1 above using the files: xop1.9_common.tar.Z.encrypted xop1.9_data.tar.Z xop1.9_developer.tar.Z xop1.9_bin_.tar.Z 2) customize the script file xop by defining the environmental variable XOP_HOME. The environmental variable IDL_DIR must be defined to point to the IDL installation. 3) start XOP in DEVELOPER mode by using the -d switch, ./xop -d 4) all three modes can be installed simultaneously 3) WINDOWS Installation Notes (EMBEDDED mode): ============================================== 1) download the file setupex_xop19e.exe (12189669 bytes). Alternatively, donwload the splitted files and the batch file which build the setupex_xop19e.exe file. Those files can be found in the setupex_xop19e-splitted directory. 2) execute the setupex_xop19e.exe file and follow the instructions. An installation password can be obtained by completing the registration form and e-mailing it to srio@esrf.fr and/or dejus@aps.anl.gov. 4) Authors and Support: ======================= Manuel Sanchez del Rio (srio@esrf.fr) and Roger J. Dejus (dejus@aps.anl.gov).