Welcome to the documentation of eXSpy!

eXSpy is a Python package extending the functionality for multi-dimensional data analysis provided by the HyperSpy library. It is aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS) and Electron Energy Loss Spectroscopy (EELS).

Check out the installation section for further information, including how to start using this project.

Note

This is an open-source community project: everyone is welcome to contribute. Please read our (see Contributing) guidelines and get started!

Learning resources

Getting Started

New to eXSpy or the HyperSpy ecosystem? The getting started guide provides an introduction on basic usage of eXSpy and how to install it.

User Guide

The user guide provides in-depth information on key concepts of eXSpy and how to use it along with background information and explanations.

Reference

Documentation of the metadata specification and of the Application Progamming Interface (API), which describe how eXSpy functions work and which parameters can be used.

Example

Gallery of short examples illustrating simple tasks that can be performed with eXSpy and HyperSpy.

Tutorials

Tutorials in form of Jupyter Notebooks to learn how to process multi-dimensional electron/X-ray spectroscopy data using eXSpy.

Contributing

eXSpy and the whole HyperSpy ecosystem are a community project maintained for and by its users. There are many ways you can help!

Citing eXSpy

If eXSpy has been significant to a project that leads to an academic publication, please acknowledge that fact by citing it. The DOI in the badge below is the Concept DOI of eXSpy. It can be used to cite the project without referring to a specific version. If you are citing eXSpy because you have used it to process data, please use the DOI of the specific version that you have employed. You can find it by clicking on the DOI badge below.

Citation in the scientific literature

Given the increasing number of articles that cite HyperSpy and its extension packages, we do not maintain a list of articles citing eXSpy or HyperSpy. For an up to date list search for exspy/HyperSpy in a scientific database e.g. Google Scholar.

Warning

Articles published before 2012 may mention the HyperSpy project under its old name, EELSLab.

License

eXSpy is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version.

eXSpy is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.