User Guide

Note

This guide is continuously updated as ERLabPy evolves. If something is unclear or missing, please open an issue on GitHub.

For the full list of packages and modules, see API Reference.

Introduction

Welcome to the User Guide! This guide provides an overview of the main features and workflows in ERLabPy.

If you are new, you may want to start with the getting started guide.

ERLabPy has both Python code-based workflows and GUI-based workflows. The two are designed to work together, with the GUI serving as an interactive layer on top of the Python APIs. See GUI and Python Side by Side for a side-by-side map of the GUI and Python equivalents for common analysis tasks.

Table of Contents

• Reading & writing data
  • Reading data with xarray
  • Writing xarray objects to a file
  • ARPES data
  • Implementing a data loader plugin
• Selecting & indexing
  • Basic xarray operations
  • The qsel accessor
  • Masking
  • Interpolation
  • GUI equivalent
• Plotting
  • Importing
  • Plotting 2D data
  • Annotations
  • Brillouin zones
  • 2D colormaps
  • Styling figures
  • Tips
  • Miscellaneous
• Momentum conversion
  • Nomenclature
  • Momentum conversion
  • Converting coordinates only
  • \(k_z\)-dependent data
  • GUI equivalent
• Curve fitting
  • Fermi edge fitting
  • Pre-defined models
  • Fitting across multiple dimensions
  • Parallelization
  • Fitting multidimensional models
  • Various tips on curve fitting
  • Visualizing fits
  • Saving and loading fits
  • GUI equivalent
  • Using iminuit
• Transformations
  • Rotate maps and volumes
  • Shift spectra to correct drift
  • Symmetrization
• Filtering
  • Image smoothing filters
  • Visualizing dispersive features
• GUI and Python Side by Side
  • Operation map
• Interactive tools
  • ImageTool
  • ImageTool Manager
  • Other interactive tools
  • Configuration
  • Authoring interactive tools

Further reading

• Lectures on scientific computing with Python

• The beginner’s guide to numpy

• Xarray tutorial