Skip to content

hyperspy/exspy-demos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

exSpy demos

Live demos (Binder) Notebook Viewer (nbviewer) Documentation Status

Introduction

This repository contains Jupyter Notebooks to demo and learn how to process electron energy loss spectroscopy (EELS) and X-ray energy dispersive spectroscopy (EDS) with exSpy. For learning purposes, we recommend to use them alongside the exSpy User Guide.

exSpy uses the HyperSpy framework and to learn about generic functionalities of HyperSpy, see the HyperSpy user guide and the HyperSpy demos.

Visualising and running the demos.

(Interactive) Running the demos online

Live demos (Binder)

Follow this link or click the "launch binder" banner above to run the the demos on mybinder.org. The demos will run remotely, and one can experiment with HyperSpy in a Jupyter notebook with no need to install or configure any software locally.

Note: depending on the remote server load, the interactive binder demo may take up to several minutes to load. For a quicker (but non-interactive) visualization, see below.

(Non-interactive) Visualizing the demos online

Notebook Viewer (nbviewer)

Follow this link or click on the "render nbviewer" banner above to display the demos with the Jupyter Notebook viewer. nbviewer will allow you to view the notebooks online, but you will not be able to change them or evaluate any code, like is possible with the binder.

Running and visualizing the demos locally

To run the demo notebooks locally, clone or download the demos repository to your local machine, install HyperSpy and Jupyter Lab or Jupyter Notebook and use either of Jupyter tools to run the notebooks.

(For developers) Testing the demos locally

To test the demos, install nbval and pytest and run

$ pytest

To help visualize differences/errors, install nbdime as well, and run the test with

$ pytest --nbdime

Contributing

To contribute new demos or improvements to the current ones fork the demos repository and send us a pull request. See the HyperSpy Developer Guide for more details on how to contribute to HyperSpy.

For issues and discussions fill a new issue in the demos github repository or discuss it in HyperSpy's gitter chat.