Welcome to HoloSpy’s documentation!

HoloSpy 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 (off-axis) electron holography data. Originally developed as part of HyperSpy, these and other domain specific features have been split out into dedicated packages with the HyperSpy 2.0 release.

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 holoSpy or the HyperSpy ecosystem? The getting started guide provides an introduction on basic usage of holoSpy and how to install it.

User Guide

The user guide provides in-depth information on key concepts of holoSpy 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 holoSpy functions work and which parameters can be used.

Tutorials

Tutorials in form of Jupyter Notebooks to learn how to process off-axis electron holography data using holoSpy.

Contributing

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

Changes

To learn about recent changes, check out the release notes.

Citing HoloSpy

HoloSpy is maintained by the HyperSpy community.

If HoloSpy 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 – it can be used to cite the project without referring to a specific version. If you are citing HoloSpy 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:

License

HoloSpy 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.

HoloSpy 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.