User Guide

Work in Progress

The user guide is a work in progress. If you have any questions or suggestions, please feel free to 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

• Interactive tools
  • ImageTool
  • ImageTool Manager
  • Other interactive tools
  • Configuration
• 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
  • 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
  • Fitting background models
  • Visualizing fits
  • Saving and loading fits
  • Using iminuit
• Filtering
  • Image smoothing filters
  • Visualizing dispersive features
  • Interactive differentiation

Further reading

• Lectures on scientific computing with Python

• The beginner’s guide to numpy

• Xarray tutorial