Metadata-Version: 2.1
Name: orix
Version: 0.11.1
Summary: orix is an open-source Python library for handling crystal orientation mapping data.
Home-page: https://orix.readthedocs.io
Author: orix developers
Author-email: pyxem.team@gmail.com
License: GPLv3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: doc
Provides-Extra: tests
Provides-Extra: dev
License-File: LICENSE

|binder|_ |build_status|_ |Coveralls|_ |docs|_ |pypi_version|_  |downloads|_ |black|_ |doi|_

.. |binder| image:: https://mybinder.org/badge_logo.svg
.. _binder: https://mybinder.org/v2/gh/pyxem/orix/HEAD

.. |build_status| image:: https://github.com/pyxem/orix/workflows/build/badge.svg
.. _build_status: https://github.com/pyxem/orix/actions

.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/orix/badge.svg?branch=develop
.. _Coveralls: https://coveralls.io/github/pyxem/orix?branch=develop

.. |docs| image:: https://readthedocs.org/projects/orix/badge/?version=latest
.. _docs: https://orix.readthedocs.io/en/latest

.. |pypi_version| image:: https ://img.shields.io/pypi/v/orix.svg?style=flat
.. _pypi_version: https://pypi.python.org/pypi/orix

.. |downloads| image:: https://anaconda.org/conda-forge/orix/badges/downloads.svg
.. _downloads: https://anaconda.org/conda-forge/orix

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. _black: https://github.com/psf/black

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3459662.svg
.. _doi: https://doi.org/10.5281/zenodo.3459662

orix is an open-source Python library for analysing orientations and crystal symmetry.

The package defines objects and functions for the analysis of orientations represented
as quaternions or 3D rotation vectors accounting for crystal symmetry. Functionality
builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
<https://matplotlib.org>`_ and is heavily inspired by the MATLAB package `MTEX
<https://mtex-toolbox.github.io>`_.

orix is released under the GPL v3 license.

Documentation
-------------

Refer to the `documentation <https://orix.readthedocs.io>`__ for detailed installation
instructions, a user guide, and the `changelog
<https://orix.readthedocs.io/en/latest/changelog.html>`_.

Installation
------------

orix can be installed with ``pip``::

    pip install orix

or ``conda``::

    conda install orix -c conda-forge

You can also visit `PyPI <https://pypi.org/project/orix>`_, `Anaconda
<https://anaconda.org/conda-forge/orix>`_ or `GitHub <https://github.com/pyxem/orix>`_
to download the source.

Further details are available in the `installation guide
<https://orix.readthedocs.io/en/latest/installation.html>`_.

Citing orix
-----------

If analysis using orix forms a part of published work please cite the paper (`journal
<https://doi.org/10.1107/S1600576720011103>`_, `arXiv
<https://arxiv.org/abs/2001.02716>`_) and/or `the software
<https://doi.org/10.5281/zenodo.3459662>`_.
