This repository contains Jupyter Notebooks to demonstrate and learn how to process multi-dimensional luminescence spectroscopy data with LumiSpy. For learning purposes, refer also to the HyperSpy User Guide, as LumiSpy extends HyperSpy by signal types specifically for luminescence spectroscopy.
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 LumiSpy 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.
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 it is possible with binder.
To run the demo notebooks locally, clone or download the demos repository to your local machine, install LumiSpy with its dependencies and Jupyter Lab or Jupyter Notebook and use either of the two to run the notebooks.
To test the demos, install nbval and py.test and run
$ py.testTo help visualize differences/errors, install nbdime as well, and run the test with
$ py.test --nbdimeTo contribute new demos or improvements to the current ones, fork the demos repository and send us a pull request. See the LumiSpy contributing guide as well as the HyperSpy Developer Guide for more details on how to contribute to the HyperSpy universe.
For issues and discussions file a new issue in this repository.
