Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyxem/orix

Analysing crystal orientations and symmetry in Python
https://github.com/pyxem/orix

crystallography numpy orientation python quaternion texture

Last synced: about 20 hours ago
JSON representation

Analysing crystal orientations and symmetry in Python

Host: GitHub
URL: https://github.com/pyxem/orix
Owner: pyxem
License: gpl-3.0
Created: 2018-01-11T10:58:34.000Z (almost 7 years ago)
Default Branch: develop
Last Pushed: 2024-10-08T15:22:12.000Z (3 months ago)
Last Synced: 2024-12-15T05:03:57.884Z (8 days ago)
Topics: crystallography, numpy, orientation, python, quaternion, texture
Language: Python
Homepage: https://orix.readthedocs.io
Size: 48.6 MB
Stars: 83
Watchers: 9
Forks: 50
Open Issues: 65
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE

Awesome Lists containing this project

README

|logo| orix
===========

.. |logo| image:: https://raw.githubusercontent.com/pyxem/orix/develop/doc/_static/img/orix_logo.png
:width: 50

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 and 3D rotation vectors, accounting for crystal symmetry.
Functionality builds primarily on `NumPy `_ and `Matplotlib
`_.
Initiation of the package was inspired by `MTEX `_.

orix is released under the GPL v3 license.

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

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/orix.svg?logo=conda-forge&logoColor=white
:target: https://anaconda.org/conda-forge/orix

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

.. |python| image:: https://img.shields.io/badge/python-3.10+-blue.svg
:target: https://www.python.org/downloads/

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

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/orix.svg?label=PyPI%20downloads
:target: https://pypi.org/project/orix/

.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/orix.svg?label=Conda%20downloads
:target: https://anaconda.org/conda-forge/orix

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

.. |GPLv3| image:: https://img.shields.io/github/license/pyxem/orix
:target: https://opensource.org/license/GPL-3.0

.. |GH-discuss| image:: https://img.shields.io/badge/GitHub-Discussions-green?logo=github
:target: https://github.com/pyxem/orix/discussions

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

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

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

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

Refer to the `documentation `__ for detailed installation
instructions, a user guide, and the `changelog
`_.

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

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

pip install orix

or ``conda``::

conda install orix -c conda-forge

The source code is hosted in `GitHub `_, and can also be
downloaded from `PyPI `_ and
`Anaconda `_.

Further details are available in the
`installation guide `_.

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

If analysis using orix forms a part of published work please cite the paper (`journal
`_, `arXiv
`_) and `the software
`_.