ViPErLEED documentation

Welcome to the documentation of ViPErLEED and of the viperleed Python package. The ViPErLEED project comprises a set of open-source tools that aims at drastically reducing the effort for quantitative low-energy electron diffraction [i.e., LEED-I(V)] on both experimental and computational fronts.

The ViPErLEED source code is hosted on GitHub at https://github.com/viperleed.

Fig. 1 shows an overview of the tools provided by the ViPErLEED project:

• The ViPErLEED hardware

  A set of hardware, firmware and control software for the easy acquisition of LEED-I(V) data with pre-existing LEED systems [1].

• The ViPErLEED ImageJ plugins

  Software for extracting I(V) curves from the experimental data (“movies”) [2].

• The viperleed.calc package

  A Python package for the calculation of I(V) curves, quantitative analysis of LEED data, and surface-structure optimization [3].

Fig. 1 Overview of the parts of the ViPErLEED project.

Getting started

• Installation
  • Installing the ViPErLEED ImageJ plugins
  • Installing Python
  • Installing the ViPErLEED Python package
  • Windows Subsystem for Linux
  • Using a Python virtual environment
• Command-line tools
  • viperleed
  • viperleed calc
• Background
  • LEED I(V)
  • The tensor-LEED approach
  • Plane symmetry groups

viperleed.calc

• viperleed calc
  • Installing tensor-LEED dependencies
  • Examples
  • Conventions
  • How to run
  • ViPErLEED work segments
  • Files
  • Parameters
  • viperleed bookkeeper
  • Utilities

ViPErLEED ImageJ plugins

• ViPErLEED ImageJ plugins

Hardware and measurements

• Hardware

ViPErLEED Python API

• ViPErLEED Python API

Appendix

• Citing ViPErLEED
• References
• Glossary
• License
• Notes for developers