https://github.com/hyperspy/hyperspy-demos

HyperSpy Jupyter Notebooks demos
https://github.com/hyperspy/hyperspy-demos

data-analysis data-visualization hyperspy materials-science multi-dimensional physical-sciences python tutorial

Last synced: about 1 month ago
JSON representation

HyperSpy Jupyter Notebooks demos

• Host: GitHub
• URL: https://github.com/hyperspy/hyperspy-demos
• Owner: hyperspy
• Created: 2014-06-18T11:05:40.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T16:22:24.000Z (7 months ago)
• Last Synced: 2024-05-18T11:27:57.428Z (7 months ago)
• Topics: data-analysis, data-visualization, hyperspy, materials-science, multi-dimensional, physical-sciences, python, tutorial
• Language: Jupyter Notebook
• Homepage:
• Size: 60.2 MB
• Stars: 54
• Watchers: 26
• Forks: 44
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HyperSpy demos

[![Live demos (Binder)](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/hyperspy/hyperspy-demos/main)

[![Notebook Viewer (nbviewer)](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg?sanitize=true)](https://nbviewer.org/github/hyperspy/hyperspy-demos)

[![Documentation Status](https://readthedocs.org/projects/hyperspy/badge/?version=stable)](https://hyperspy.readthedocs.io/en/stable/?badge=stable)

## Introduction

This repository contains [Jupyter Notebooks](http://jupyter.org/) to demo and learn

how to process multi-dimensional data with [HyperSpy](https://hyperspy.org). For

learning purposes, we recommend to use them alongside the 

[HyperSpy User Guide](https://hyperspy.org/hyperspy-doc/current).

The root folder contains notebooks concerning general HyperSpy features while

the subfolders contain notebooks for specific signals and other more specialized

analyses.

## Visualising and running the demos.

### (Interactive) Running the demos online

[![Live demos (Binder)](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/hyperspy/hyperspy-demos/main)

Follow [this link](https://mybinder.org/v2/gh/hyperspy/hyperspy-demos/main)

or click the "launch binder" banner above to run the the demos on 

[mybinder.org](https://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)](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg?sanitize=true)](https://nbviewer.org/github/hyperspy/hyperspy-demos)

Follow [this link](https://nbviewer.org/github/hyperspy/hyperspy-demos)

or click on the "render nbviewer" banner above

to display the demos with the 

[Jupyter Notebook viewer](http://nbviewer.jupyter.org). 

[nbviewer](http://nbviewer.jupyter.org/) 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](https://mybinder.org/v2/gh/hyperspy/hyperspy-demos/main).

### Running and visualizing the demos locally

To run the demo notebooks locally, 

clone or download the [demos repository](https://github.com/hyperspy/hyperspy-demos) 

to your local

machine, install HyperSpy and

[Jupyter Lab](http://jupyterlab.readthedocs.io/en/latest/) or 

[Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/)

and use either of Jupyter tools to run the notebooks.

#### (For developers) Testing the demos locally

To test the demos, install

[nbval](http://github.com/computationalmodelling/nbval) and

[py.test](https://pytest.org/) and run

```bash

$ py.test

```

To help visualize differences/errors, install

[nbdime](http://github.com/jupyter/nbdime) as well, and run the test with

```bash

$ py.test --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](http://hyperspy.org/hyperspy-doc/current/dev_guide.html) 

for more details on how to contribute to HyperSpy.

For issues and discussions fill a new

issue in [the demos github repository](https://github.com/hyperspy/hyperspy-demos)

or discuss it in [HyperSpy's gitter chat](https://gitter.im/hyperspy/hyperspy).