https://github.com/hyperspy/hyperspy_gui_ipywidgets

ipywidgets GUI elements for HyperSpy
https://github.com/hyperspy/hyperspy_gui_ipywidgets

hyperspy-extension

Last synced: about 1 year ago
JSON representation

ipywidgets GUI elements for HyperSpy

• Host: GitHub
• URL: https://github.com/hyperspy/hyperspy_gui_ipywidgets
• Owner: hyperspy
• License: gpl-3.0
• Created: 2017-05-16T15:10:58.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T12:18:17.000Z (about 1 year ago)
• Last Synced: 2025-04-22T22:42:47.172Z (about 1 year ago)
• Topics: hyperspy-extension
• Language: Python
• Size: 294 KB
• Stars: 11
• Watchers: 5
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hyperspy_gui_ipywidgets

[![Tests](https://github.com/hyperspy/hyperspy_gui_ipywidgets/workflows/Tests/badge.svg)](https://github.com/hyperspy/hyperspy_gui_ipywidgets/actions)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hyperspy_gui_ipywidgets.svg)](https://pypi.org/project/hyperspy-gui-ipywidgets)

[![PyPI](https://img.shields.io/pypi/v/hyperspy_gui_ipywidgets.svg)](https://pypi.org/project/hyperspy-gui-ipywidgets)

[![Anaconda Cloud](https://anaconda.org/conda-forge/hyperspy-gui-ipywidgets/badges/version.svg)](https://anaconda.org/conda-forge/hyperspy-gui-ipywidgets)

**hyperspy_gui_ipywidgets** provides ipywidgets graphic user interface (GUI) elements for hyperspy.

## Installation

### Option 1: With pip

Make sure you have

[pip installed](https://pip.pypa.io/en/stable/installing/) and run:

```bash

pip install hyperspy_gui_ipywidgets

```

### Option 2: With Anaconda

Install anaconda for your platform and run

```bash

conda install hyperspy-gui-ipywidgets -c conda-forge

```

## Running the tests

py.test is required to run the tests.

```bash

pip install "hyperspy_gui_ipywidgets[test]"

py.test --pyargs hyperspy_gui_ipywidgets

```

## Usage

Please refer to the [HyperSpy documentation](http://hyperspy.org/hyperspy-doc/current/index.html) for details. Example (to run in the [Jupyter Notebook](http://jupyter.org/)):

```python

import hyperspy.api as hs

hs.preferences.gui(toolkit="ipywidgets")

```

![HyperSpy preferences ipywidget](https://github.com/hyperspy/hyperspy_gui_ipywidgets/raw/main/images/preferences_gui.png "HyperSpy preferences ipywidget")

## Development

Contributions through pull requests are welcome. See the

[HyperSpy Developer Guide](http://hyperspy.org/hyperspy-doc/current/dev_guide.html).