ViPErLEED-betatest

The most recent executables for the ViPErLEED package. The complete source code of the ViPErLEED package will be made available to the general public as soon as possible (i.e., after submission of relevant manuscripts).

The contents of this repository are solely intended for internal use, and should not be distributed without explicit consent. Please contact riva@iap.tuwien.ac.at in advance if you wish to redistribute any of the content. We are happy to officially include new users as beta testers.

You find the most recent release in the Releases section on the right. Each release is accompanied by a Change Log with the most recent changes, and contains:

• doc: archive with the most recent documentation. Accessed by opening the ./doc/index file in a web browser. Note: Files are displayed correctly under Linux. Using Firefox is strongly suggested for opening the documentation on Windows.
• gui: archive containing the graphical user interface (Windows >= 7, UNIX) and some example input files. Offers a LEED pattern preview, and exports a PatternFile.csv required by the spot tracker (see pattern file examples for some examples). The input file for your current structure is also automatically generated by tleedm upon initialization from a POSCAR file, and can be found in the OUT folder as PatternInfo.tlm. This file can be opened in the GUI (drag-drop, File>Open..., or Ctrl+O).
• imagej_plugins: spot tracker and curve editor. Platform independent. Used for extracting IV curves from a LEED movie and for post-processing the intensities (averaging symmetry-equivalent beams and smoothing). Produces the EXPBEAMS.csv file that is needed for running LEED-IV calculations. If you do not have ImageJ, you can downaload it here (mirror site). Please keep your ImageJ version up to date using the Help>Update ImageJ... menu (requires write access to the ImageJ directory). Requirements on the ImageJ version can be found in the Release description. If the Help>Update ImageJ... does not work, you can download the most recent ij.jar file here, and replace the one in your ImageJ install path. On MacIntosh OS X, you have to right-click the ImageJ icon and select Show Package Contents. The ij.jar file is in Contents/Resources/Java. Then place the .jar file into your %ImageJ install path%/plugins/ folder, remove previous versions, and restart ImageJ. Note: you can rename the .jar file to your liking, but the file name must contain at least one underscore _ to be detected by ImageJ. The plugins will be available in the Plugins>ViPErLEED Menu. Use Plugins>ViPErLEED>Open LEED Movie (for .vid files from the EE2000/EE2010 "Aida" data acquisistion system and .zip files generated by the ViPErLEED measurement package), File>Open/File>Import>... for other video types, or File>Import>Image Sequence.../File>Import>Raw... for a collection of frames. The Spot Tracker and I(V) Curve Editor have Help buttons with documentation on their use.
• tleedm: for LEED-IV calculations. This is usually only packed for UNIX. Performs LEED-IV calculations based on the TensErLEED package from input files. This creates quite a lot of files, so it is recommended to have an additional job script (see, e.g., example-job.sh) moving the input files and tleedm executable into a work folder and executing it there. When exiting, tleedm will create a manifest file, which is a list of files and folders that should be copied back. Note that tleedm requires access to a fortran compiler (preferrably ifort) on the workstation. See documentation on the FORTRAN_COMPILE parameter for details.
• bookkeper: for keeping track of your calculations in a file history.info. This is usually only packed for UNIX. See example-job.sh for an example of bookkeeper usage. Execute bookkeeper with flag -c for continuation jobs, i.e. to overwrite the POSCAR and VIBROCC input files in the main folder with the latest POSCAR_OUT and VIBROCC_OUT from the OUT folder.
• tensorleed: archive of the core TensErLEED [Comput. Phys. Commun. 134, 392 (2001)], and related code. EEASiSSS [Phys. Rev. B 76, 195441 (2007)] is distributed with kind permission from John Rundgren.

Please, use the Issues tab to open new issues should you encounter any bug, for new-feature requests, as well as for comments on usability of the package.

You can also open an Issue in case you would like executables packed for different operating systems.