diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ecb7fd1c2d --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +[![Azure pipelines status](https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_apis/build/status/hyperspy.hyperspy?branchName=RELEASE_next_minor)](https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_build?definitionId=1&_a=summary&view=branches) +[![Tests status](https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml/badge.svg)](https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml) +[![Documentation status](https://readthedocs.org/projects/hyperspy/badge/?version=latest)](https://hyperspy.readthedocs.io/en/latest/?badge=latest) +[![Codecov coverage](https://codecov.io/gh/hyperspy/hyperspy/graph/badge.svg?token=X7T3LE121Q)](https://codecov.io/gh/hyperspy/hyperspy) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/hyperspy/hyperspy/RELEASE_next_minor.svg)](https://results.pre-commit.ci/latest/github/hyperspy/hyperspy/RELEASE_next_minor) + + +[![Python Version](https://img.shields.io/pypi/pyversions/hyperspy.svg?style=flat)](https://pypi.python.org/pypi/hyperspy) +[![PyPI Version](http://img.shields.io/pypi/v/hyperspy.svg?style=flat)](https://pypi.python.org/pypi/hyperspy) +[![Anaconda Version](https://anaconda.org/conda-forge/hyperspy/badges/version.svg)](https://anaconda.org/conda-forge/hyperspy) + +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hyperspy/hyperspy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![DOI](https://zenodo.org/badge/2233998.svg)](https://zenodo.org/badge/latestdoi/2233998) + + +**HyperSpy** is an open source Python library for the interactive analysis of +multidimensional datasets that can be described as multidimensional arrays +of a given signal (for example, a 2D array of spectra, also known as a +spectrum image). + +**HyperSpy** makes it straightforward 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. + +Its modular structure makes it easy to add features to analyze many different +types of signals. Visit the [HyperSpy Website] to learn more about HyperSpy and +its extension packages and for instructions on how to install the package and get +started in analysing your data. + +HyperSpy is released under the GPL v3 license. + +**Since version 0.8.4, HyperSpy only supports Python 3.** If you need to install +HyperSpy in Python 2.7, please install version 0.8.3. + +Contributing +------------ + +Everyone is welcome to contribute. Please read our +`contributing guidelines `_ and get started! + + diff --git a/README.rst b/README.rst deleted file mode 100644 index 479fa2be22..0000000000 --- a/README.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. -*- mode: rst -*- - -|Azure|_ |Github|_ |pre-commit|_ |rtd|_ |Codecov|_ - -|python_version|_ |pypi_version|_ |anaconda_cloud|_ - -|gitter|_ |DOI|_ - -.. |Azure| image:: https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_apis/build/status/hyperspy.hyperspy?branchName=RELEASE_next_minor -.. _Azure: https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_build?definitionId=1&_a=summary&view=branches - -.. |Github| image:: https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml/badge.svg -.. _Github: https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml - -.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/hyperspy/hyperspy/RELEASE_next_minor.svg -.. _pre-commit: https://results.pre-commit.ci/latest/github/hyperspy/hyperspy/RELEASE_next_minor - -.. |Codecov| image:: https://codecov.io/gh/hyperspy/hyperspy/branch/RELEASE_next_minor/graph/badge.svg -.. _Codecov: https://codecov.io/gh/hyperspy/hyperspy - -.. |rtd| image:: https://readthedocs.org/projects/hyperspy/badge/?version=latest -.. _rtd: https://readthedocs.org/projects/hyperspy/?badge=latest - -.. |pypi_version| image:: http://img.shields.io/pypi/v/hyperspy.svg?style=flat -.. _pypi_version: https://pypi.python.org/pypi/hyperspy - -.. |anaconda_cloud| image:: https://anaconda.org/conda-forge/hyperspy/badges/version.svg -.. _anaconda_cloud: https://anaconda.org/conda-forge/hyperspy - -.. |python_version| image:: https://img.shields.io/pypi/pyversions/hyperspy.svg?style=flat -.. _python_version: https://pypi.python.org/pypi/hyperspy - -.. |gitter| image:: https://badges.gitter.im/Join%20Chat.svg -.. _gitter: https://gitter.im/hyperspy/hyperspy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge - -.. |DOI| image:: https://zenodo.org/badge/2233998.svg -.. _DOI: https://zenodo.org/badge/latestdoi/2233998 - - -HyperSpy is an open source Python library for the interactive analysis of -multidimensional datasets that can be described as multidimensional arrays -of a given signal (for example, a 2D array of spectra, also known as a -spectrum image). - -HyperSpy makes it straightforward 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. - -Its modular structure makes it easy to add features to analyze many different -types of signals. - -HyperSpy is released under the GPL v3 license. - -**Since version 0.8.4, HyperSpy only supports Python 3.** If you need to install -HyperSpy in Python 2.7, please install version 0.8.3. - -Contributing ------------- - -Everyone is welcome to contribute. Please read our -`contributing guidelines `_ and get started! - -