.. HyperSpyUI documentation master file, created by sphinx-quickstart on Mon Feb 1 21:17:07 2016. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. HyperSpyUI - A Graphical interface for HyperSpy ================================================== 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: http://hyperspy.org 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. As HyperSpyUI is made in Python, the same programming language as HyperSpy, the integration is seamless. Development status ------------------ Currently, the development of HyperSpyUI is focused on strengthening its back-bone and making sure that it is as easy as possible to add new features to the UI. There is also an ongoing efort to add easy, intuitive access to as many of HyperSpy's features as possible. HyperSpy itself is stated to be in a "perpetual beta". As such, the UI will never be more stable than the underlying drivetrain, however, that should only affect the analytical capabilities. The application itself is based on the mature Qt framework, and should therefore be robust. User guide ---------- .. toctree:: :maxdepth: 2 installation.rst what_is_new.rst quickstart.rst actions.rst tools.rst widgets.rst settings.rst troubleshooting.rst Developer guide --------------- While the UI doesn't easily lend itself to being used as a library, understanding the UI API is of importance for anybody that want to add plugins, or simply want to execute some code in the :ref:`console`. .. toctree:: :maxdepth: 2 devguide.rst .. toctree:: :maxdepth: 1 api/hyperspyui.rst api/hyperspyui.plugins.rst api/modules.rst Indices and tables ------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search`