/////////////////////////////////////////////////////////////////////// Distribution: Jfeff Copyright (c) [2007] University of Washington This software was prepared in part with US Government Funding under DOE contract DE-FG03-97ER45623. Redistribution and use of this Distribution in source and binary formats, with or without modification is permitted, provided the following conditions are met: Redistributions must retain the above notices and the following list of conditions and disclaimer; Modified formats carry the marking "Based on or developed using Distribution: Jfeff 8.4 Jfeff 8.4 Copyright (c) [2007] University of Washington" Recipient acknowledges the right of the University of Washington to prepare uses of this Distribution and its modifications that may be substantially similar or functionally equivalent to Recipient-prepared modifications. Recipient and anyone obtaining access to the Distribution through recipient's actions accept all risk associated with possession and use of the Distribution. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF WASHINGTON OR CONTRIBUTORS TO THE DISTRIBUTION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR REVENUE; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /////////////////////////////////////////////////////////////////////// License is applicable for routines below, until otherwise specified. Jfeff 8.4 is a java based GUI for feff. It has been built and tested using the Sun JDK version 1.5.0 on Linux and WindowsXP. It is also known to run on OSX under the JRE provided by Apple. This version recognizes cards for feff84. Before installing jfeff you must have a Java Runtime Environment installed. The recommended JRE for Linux and WindowsXP is the one provided by Sun. If your system does not already have it installed, you can download a version from java.sun.com. http://java.sun.com/javase/downloads/index.jsp Only the Java Runtime Environment (JRE) is required. You may download and install any of the JDK releases instead of the JRE if you plan to develop or compile Java source code. To run feff using jfeff you must also have a copy of feff84 installed and compiled in the modular fashion. Please see the feff documentation for instructions on how to do this for your system. More information including a short tutorial can be found on the website http://students.washington.edu/bitsed/jfeff/ Installation for UNIX based systems The scripts only write files to the current directory, so you don't need to worry about them creating strange files in odd places. - open a shell/xterm - cd to the same directory as this README - make sure java is in your path, if it isn't the install script will prompt you for the location of your java runtime - run the install_unix.sh shell script and follow the directions $ cd /path/to/directory/jfeff $ java -version $ ./install_unix.sh After you've run the install script you can either use one of the jfeff.desktop files for KDE/GNOME, or you can start jfeff from the shell. $ ./jfeff If you need to move this jfeff directory, then you should unpack the original archive in the new location and repeat the install process outlined above. Installation for Windows On windows the application can be started using explorer provided that the java runtime installed the application linking for the jar file type. Use the windows explorer to navigate to the directory where you unpacked the archive. In the dist directory there is a file named JFEFF.jar that you should double click. If the above doesn't work there is a DOS install script that will create a DOS bat file that can be used to start the application. The script only write files to the current directory, so you don't need to worry about them creating strange files in odd places. - open the Explore file system - double click your way to the same directory as this README - make sure java is in your path, if it isn't the install script will prompt you for the location of your java runtime - double click the install_win32.bat and follow the directions After you've run the install script you can start jfeff by either double clicking the jfeff.bat, or you can start jfeff from the DOS shell $ jfeff.bat If you need to move this jfeff directory, then you should unpack the original archive in the new location and run the install_win32.bat script again. Configuration Before running feff from the jfeff main window you must tell jfeff where to find the feff modular executables installed on your system. - Select Options->Settings from the main menu - Click the "Browse" button adjacent to the feff installation directory text field and use the navigator to select the directory where feff84 files are located. For instance, if your feff modular executables are located in /opt/feff84/bin/Seq, then you need to select /opt/feff84/bin/Seq as the feff modules directory. The GUI will check that the rdinp module exists somewhere below the directory you've selected, so if you select your root directory your entire filesystem will be searched. You may use the Recently Used Menu Entries setting to adjust to number of files saved in the File->Recently Used menu. Opening feff.inp files and running feff When jfeff is started it loads some basic default settings. To load the contents of a feff.inp file into jfeff use the File->Open menu, and select an .inp file using to navigator. After an .inp file is opened a recently used menu entry is added for the file. You may use the controls in the main frame to edit your feff.inp file. When you are ready to run feff, select the modules you wish to run, and click the run button. It is important to note that feff only accepts files named feff.inp as input, so the GUI will save the current settings into a file named feff.inp the same directory as the .inp file listed in the title bar. The Run button will automatically overwrite any existing feff.inp file in this directory before starting feff. To save your current feff.inp settings in another location use the File->Save As menu, and select a directory where the feff.inp file will be saved. This directory is the working directory for feff, and jfeff will run feff from inside this directory keeping all feff output and data files in the same place as the feff.inp file. Because of this it's required that there be at most one feff.inp file in any given directory for jfeff to work properly. Viewing plots of feff data After running feff, the directory containing the feff.inp file will have many files output from feff. Some of these files contain data that may be plotted. To plot the data in these files select Plot from the menu. A plot frame will open and plot columns one and four from xmu.dat by default. You may open other data files using the File->Open menu in the plot frame. Viewing help text To view help text, select Help from the menu in the main frame. A new help text frame will appear. To view help, move the mouse cursor over a label in the main frame. The help text for that particular card will appear in the help frame.