Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 3.25 KB

index.rst

File metadata and controls

87 lines (68 loc) · 3.25 KB

Welcome to LumiSpy's documentation!

_ Tests_ Codecov_status_ CodeQL_status_ Python_version_ PyPI_version_ Anaconda_version_ License_ DOI_ Documentation_status_

LumiSpy 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 luminescence spectroscopy data (cathodoluminescence, photoluminescence, electroluminescence, Raman, SNOM).

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

Complementing this documentation, the LumiSpy Demos repository contains curated Jupyter notebooks to provide tutorials and exemplary workflows.

Note

This project is under active development. Everyone is welcome to contribute. Please read our (see contributing_label) guidelines and get started!

Contents

user_guide/installation.rst user_guide/introduction.rst user_guide/signal_axis.rst user_guide/signal_tools.rst user_guide/fitting_luminescence.rst user_guide/utilities.rst user_guide/metadata_structure.rst user_guide/bibliography.rst

api/modules.rst

changelog.rst

citing.rst contributing.rst license.rst On GitHub <https://github.com/LumiSpy/lumispy>