Spurion program for single crystal triple axis spectrometers

> # Spurion program for single crystal triple axis spectrometers Tanya Riseman, NIST center for Neutron Research. Ext 8379. Room A111.

> ## Index

> - Introduction
> - How to run on NCNR computers
> - Help
> - Quick reference
> - Diagrams from the quick reference
> - Screen shots
> - Authors and contacts
> - Distribution
> - Compile

> ## Introduction

> "Spur" is a spurion program for single crystal triple axis spectrometers. Available for Linux (g77 FORTRAN compiler) and SGI operating systems.
> Return to Index

> ## How to run on NCNR computers

> To run, on Jazz (SGI OS): type "spur".
> To run on the instrument computers bt2, bt7 and bt9 (Linux OS), type "spurion"
> Return to Index

> ## Help

> There is a help facility within the program Spurion (command "h"). To view Spurion's help file outside of the program in a choice of formats:

> - HTML help file for spurion
> - ASCII help file for spurion
> - Latex help file for spurion
> - Postscript help file for spurion
> - DVI help file for spurion
> - PDF help file for spurion
> Return to Index

> ## Quick reference

> Jeff Lynn and Matt Woodward have produced a quick reference guide to Spurion.
> - Latex Spurion quick reference file for spurion
> - Postscript Spurion quick reference file for spurion
> - PDF Spurion quick reference file for spurion
> - HTML Spurion quick reference file for spurion
> Return to Index

> ## Diagrams from the quick reference

> Diagrams from the quick reference guide to Spurion.
> - Figure 1: The k-space diagram, with annotations explaining the features.
> - Figure 2: The E-space diagram, with annotations explaining the features.
> - Figure 3: Another k-space diagram, with annotations explaining transverse vs. longitudinal scans.
> Return to Index

> ## Screen shots

> Return to Index

> ## Authors and contacts

> - SPURION was written by
>   - Jeff Lynn, the dark ages, ca. 1970 (original punch-card version)
>     NIST center for Neutron Research. Ext 6246. Room A126.
>   - Carl Adams, 1997 - 2000 (graphics and Bragg Intensities)
>     NIST center for Neutron Research. Now at St. Xavier University.
>   - Tanya Riseman, 2001-2002 (scan graphics, menus)
>     NIST center for Neutron Research. Ext 8379. Room A111.
> - The LAZY and PULVERIX subroutines were originally written by
>   - K. YVON, circa 1977-1989
>     LABORATOIRE DE CRISTALLOGRAPHIE AUX RAYONS X
>     UNIVERSITY OF GENEVA
>     24 QUAI ERNEST ANSERMET, CH 1211 GENEVA, SWITZERLAND
>     TEL 022 219355
>     ADAPTED TO B6700 AT UCSD, HANS F. BRAUN, 7 FEB. 1979
>     ADAPTED TO CDC 7600 AT BNL, D. E. COX, DEC. 1984
>     modified 3.87 to prepare CPDF/PROFIL input file by P.ZOLLIKER
> - The HELP subroutine was written by
>   - Paul Kienzle, 1997
>     University of Birmingham
>     Birmingham, UK
> - Matt Woodward (frank.woodward@nist.gov, ext. 6442) can also provide assistance in using this program.
> Return to Index

> ## Distribution

> The tar ball spurion.tar contains several directories:

> - bin: The target directory for the SGI or Linux binary. Make files in source directories ./help2latex and ./src_#### (e.g. src_0301) place binaries here.
> - doc: The directory containing documentation in PDF, LaTeX, postscript and HTML formats.
> - .doc/spurion: Target directory for HTML files produced by make files in the directory ../src_####.
> - help: The directory containing the documentation in its "original" ASCII format, VMS-help style spurion.hlp.
> - help2latex: FORTRAN Code to convert the help from its original VMS-help format spurion.hlp to LaTeX. Makefiles for Linux, SGI and Alpha-VMS.
> - help_code: C library code for accessing the help file spurion.hlp from FORTRAN code.
> - ref: Contains this html file (spur_overview.html) screen shots, the quick reference guide and associated diagrams.
> - src_####. Source code directory for spurion program. The numbers in src_0301 correspond to a version date of January, 2003. The graphics package PGPLOT http://www.astro.caltech.edu/~tjp/pgplot is required, but is not be included in this distribution, due to licensing restrictions. You may have to modify the appropriate make file to specify the location of PGPLOT on your computer.
>   Before the spurion program "../bin/spur_030115_g77" can run, certain shell environment variables need to be set for PGPLOT and the local help. Modify the script "runspurion_linux" or "runspurion_sgi" as needed and use this to start the program.
> Return to Index

> ## How to compile and generate documenation

> The tar file includes directories with the following already made for Linux Redhat v7.2. For SGI, follow these directions using "makefile_*_sgi" instead of "makefile_*_g77".

> - To create ./bin/h2l_auto (Required for converting spurion.hlp to spurion.html.)
>   cd ./help2latex
>   make -f makefile_h2l_g77
> - To create ./help_code/help-paul-unx.o (Required help subroutine for spurion executable.)
>   cd ./help_code
>   make -f make_testhelp_g77 help-paul-unx.o
> - To create the Spurion executable ./bin/spur_030115_g77 (requires ./help_code/help-paul-unx.o)
>   You may rename it so it doesn't have the date stamp "_030115".
>   cd ./src_0301
>   make -f makefile_spur0301_g77
> - To create LaTeX documentation in ./doc (requires ./help/spurion.hlp.)
>   cd ./src_0301
>   make -f makefile_spur0301_g77 make_tex
> - To process LaTeX documentation, creating postscript and PDF files in ./doc
>   cd ./src_0301
>   make -f makefile_tex
> - To create HTML documentation in ./doc/spurion (requires that the latex file has been made.)
>   cd ./src_0301
>   make -f makefile_spur0301_g77 make_html
> Return to Index