HyperSpyUI
==========
|pypi_version|_ |anaconda_cloud|_ |tests|_ |python_version|_
.. |pypi_version| image:: https://img.shields.io/pypi/v/hyperspyui.svg
.. _pypi_version: https://pypi.python.org/pypi/hyperspyui
.. |anaconda_cloud| image:: https://anaconda.org/conda-forge/hyperspyui/badges/version.svg
.. _anaconda_cloud: https://anaconda.org/conda-forge/hyperspyui
.. |tests| image:: https://github.com/hyperspy/hyperspyUI/workflows/Tests/badge.svg
.. _tests: https://github.com/hyperspy/hyperspyUI/actions
.. |python_version| image:: https://img.shields.io/pypi/pyversions/hyperspyui.svg?style=flat
.. _python_version: https://pypi.python.org/pypi/hyperspyui
HyperSpyUI tries to bring a streamlined user interface to the powerful
multi-dimensional analysis capabilities of HyperSpy_. HyperSpy is an open
source Python library which provides tools to facilitate data analysis of
multidimensional datasets.
HyperSpy aims at making it easy and natural to apply analytical procedures
that operate on an individual signal to multidimensional arrays, as well as
providing easy access to analytical tools that exploit the multidimensionality
of the dataset.
While the UI tries to create a simple and intuitive interface to HyperSpy, it
still retains the raw power of HyperSpy via the UI’s built in IPython console,
which runs on the same Python kernel as the UI.
Documentation
=============
For an introduction to HyperSpyUI, see the documentation_.
Installation
============
There are several ways to install HyperSpyUI. The application itself is rather
simple to install, but its dependencies can be a bit more tricky. From version
1.1, HyperSpyUI supports both PyQt4 and PyQt5.
HyperSpy Bundle Installer
-------------------------
The quickest way to get set up is to download and install
the `HyperSpy bundle`_ installer, which includes HyperSpyUI.
.. _HyperSpy bundle: https://github.com/hyperspy/hyperspy-bundle
Anaconda/Miniconda/Miniforge
----------------------------
Download and install the `Miniforge`_ (`Miniconda`_ or `Anaconda`_) distribution
and run the following command in the anaconda prompt:
.. code-block:: bash
conda install -c conda-forge hyperspyui
.. _Miniforge: https://github.com/conda-forge/miniforge#download
.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html
.. _Anaconda: https://www.anaconda.com/products/individual
Installation via pip
--------------------
HyperSpyUI can be intall from pip. Depending on your python distribution you may
need to have C compiler on your system to install some of the dependencies.
.. code-block:: bash
pip install hyperspyui
If pyqt is not installed, run:
.. code-block:: bash
pip install PyQt5 PyQtWebEngine
Run HyperSpyUI
==============
After installation, you can run HyperSpyUI from the command prompt with:
.. code-block:: bash
hyperspyui
or
.. code-block:: bash
python -m hyperspyui
For further information, see the full documentation_.
.. _HyperSpy: https://hyperspy.org
.. _documentation: https://hyperspy.org/hyperspyUI/
Raw data
{
"_id": null,
"home_page": "http://github.com/hyperspy/hyperspyUI/",
"name": "hyperspyUI",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Vidar Tonaas Fauske",
"author_email": "vidartf+hyperspyui@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c2/9c/7fee0bedda64abdc62bd9658d93b1b68cb3a6f866c9821d238209722758c/hyperspyUI-1.3.0.tar.gz",
"platform": null,
"description": "HyperSpyUI\n==========\n\n|pypi_version|_ |anaconda_cloud|_ |tests|_ |python_version|_\n\n.. |pypi_version| image:: https://img.shields.io/pypi/v/hyperspyui.svg\n.. _pypi_version: https://pypi.python.org/pypi/hyperspyui\n\n.. |anaconda_cloud| image:: https://anaconda.org/conda-forge/hyperspyui/badges/version.svg\n.. _anaconda_cloud: https://anaconda.org/conda-forge/hyperspyui\n\n.. |tests| image:: https://github.com/hyperspy/hyperspyUI/workflows/Tests/badge.svg\n.. _tests: https://github.com/hyperspy/hyperspyUI/actions\n\n.. |python_version| image:: https://img.shields.io/pypi/pyversions/hyperspyui.svg?style=flat\n.. _python_version: https://pypi.python.org/pypi/hyperspyui\n\nHyperSpyUI tries to bring a streamlined user interface to the powerful\nmulti-dimensional analysis capabilities of HyperSpy_. HyperSpy is an open\nsource Python library which provides tools to facilitate data analysis of\nmultidimensional datasets.\n\nHyperSpy aims at making it easy and natural to apply analytical procedures\nthat operate on an individual signal to multidimensional arrays, as well as\nproviding easy access to analytical tools that exploit the multidimensionality\nof the dataset.\n\nWhile the UI tries to create a simple and intuitive interface to HyperSpy, it\nstill retains the raw power of HyperSpy via the UI\u2019s built in IPython console,\nwhich runs on the same Python kernel as the UI.\n\nDocumentation\n=============\n\nFor an introduction to HyperSpyUI, see the documentation_.\n\n\nInstallation\n============\nThere are several ways to install HyperSpyUI. The application itself is rather\nsimple to install, but its dependencies can be a bit more tricky. From version\n1.1, HyperSpyUI supports both PyQt4 and PyQt5.\n\nHyperSpy Bundle Installer\n-------------------------\nThe quickest way to get set up is to download and install\nthe `HyperSpy bundle`_ installer, which includes HyperSpyUI.\n\n.. _HyperSpy bundle: https://github.com/hyperspy/hyperspy-bundle\n\nAnaconda/Miniconda/Miniforge\n----------------------------\n\nDownload and install the `Miniforge`_ (`Miniconda`_ or `Anaconda`_) distribution\nand run the following command in the anaconda prompt:\n\n.. code-block:: bash\n\n conda install -c conda-forge hyperspyui\n\n.. _Miniforge: https://github.com/conda-forge/miniforge#download\n.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html\n.. _Anaconda: https://www.anaconda.com/products/individual\n\nInstallation via pip\n--------------------\n\nHyperSpyUI can be intall from pip. Depending on your python distribution you may\nneed to have C compiler on your system to install some of the dependencies.\n\n.. code-block:: bash\n\n pip install hyperspyui\n\nIf pyqt is not installed, run:\n\n.. code-block:: bash\n\n pip install PyQt5 PyQtWebEngine\n\n\nRun HyperSpyUI\n==============\n\nAfter installation, you can run HyperSpyUI from the command prompt with:\n\n.. code-block:: bash\n\n hyperspyui\n\nor\n\n.. code-block:: bash\n\n python -m hyperspyui\n\n\nFor further information, see the full documentation_.\n\n.. _HyperSpy: https://hyperspy.org\n.. _documentation: https://hyperspy.org/hyperspyUI/\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Hyperspy Graphical User Interface",
"version": "1.3.0",
"project_urls": {
"Homepage": "http://github.com/hyperspy/hyperspyUI/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55a9e8dfc6409225ae1a7d59025388b5b33145c795685c10c4e7aa9f026328dd",
"md5": "808d47fee224f6e636a3360ade32e46e",
"sha256": "365c10fdc083f2306dc7612e1709860c547c781096414145642ad93cea784032"
},
"downloads": -1,
"filename": "hyperspyUI-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "808d47fee224f6e636a3360ade32e46e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 640946,
"upload_time": "2023-05-04T17:19:14",
"upload_time_iso_8601": "2023-05-04T17:19:14.499473Z",
"url": "https://files.pythonhosted.org/packages/55/a9/e8dfc6409225ae1a7d59025388b5b33145c795685c10c4e7aa9f026328dd/hyperspyUI-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c29c7fee0bedda64abdc62bd9658d93b1b68cb3a6f866c9821d238209722758c",
"md5": "d3e3138a8dfc70ed57aa2902bbaf1774",
"sha256": "a3dc190041247a9af5f25ca6cd45b32afc1889928fd735a77f70e7d48ee4d2c6"
},
"downloads": -1,
"filename": "hyperspyUI-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "d3e3138a8dfc70ed57aa2902bbaf1774",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 519790,
"upload_time": "2023-05-04T17:19:16",
"upload_time_iso_8601": "2023-05-04T17:19:16.183108Z",
"url": "https://files.pythonhosted.org/packages/c2/9c/7fee0bedda64abdc62bd9658d93b1b68cb3a6f866c9821d238209722758c/hyperspyUI-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 17:19:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hyperspy",
"github_project": "hyperspyUI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "hyperspyui"
}