Welcome to HyperSpy’s documentation!

User Guide

• Introduction
• Changelog
• Installing HyperSpy
• Getting started
• The Signal class
• Axes handling
• Interactive Operations and Region of Interest (ROI)
• Signal1D Tools
• Signal2D Tools
• Data visualization
• Machine learning
• Model fitting
• Electron Energy Loss Spectroscopy
• Energy-Dispersive X-ray Spectrometry (EDS)
• Dielectric function tools
• Electron Holography
• Loading and saving data
• Events
• Working with big data
• Metadata structure
• Bibliography

Developer Guide

• Introduction
• Using Git and GitHub
• Running and writing tests
• Writing documentation
• Coding style
• Tips for writing methods that work on lazy signals
• Speeding up code
• Writing packages that extend HyperSpy
• Useful information

API References

• hyperspy
  • hyperspy package

Credits and citation

• Credits
• Citing HyperSpy

Indices and tables

• Index

• Module Index

• Search Page