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 erlab user guide! This guide provides an overview of erlab and its core features.

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

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
• 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
  • Interactive conversion
• 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
  • Interactive curve fitting tool
  • Using iminuit
• Transformations
  • Rotate maps and volumes
  • Shift spectra to correct drift
  • Symmetrize about a center
• Filtering
  • Image smoothing filters
  • Visualizing dispersive features
• Interactive tools
  • ImageTool
  • ImageTool Manager
  • Other interactive tools
  • Configuration

Further reading

• Lectures on scientific computing with Python

• The beginner’s guide to numpy

• Xarray tutorial