Skip to content

Commit 8620292

Browse files
hakonaneshakonanes
authored
Merge pull request #486 from hakonanes/update-readme
2 parents 0e0ef33 + 6c8a681 commit 8620292

File tree

2 files changed

+63
-31
lines changed

2 files changed

+63
-31
lines changed

Diff for: ‎README.rst

+59-28
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,72 @@
1111
.. in the source distributions uploaded to PyPI
1212
.. EXCLUDE
1313
14-
|binder|_ |build_status|_ |Coveralls|_ |docs|_ |pypi_version|_ |downloads|_ |black|_ |doi|_
14+
orix is an open-source Python library for analysing orientations and crystal symmetry.
1515

16-
.. |binder| image:: https://mybinder.org/badge_logo.svg
17-
.. _binder: https://mybinder.org/v2/gh/pyxem/orix/HEAD
16+
The package defines objects and functions for the analysis of orientations represented
17+
as quaternions and 3D rotation vectors, accounting for crystal symmetry.
18+
Functionality builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
19+
<https://matplotlib.org>`_.
20+
Initiation of the package was inspired by `MTEX <https://mtex-toolbox.github.io>`_.
21+
22+
orix is released under the GPL v3 license.
23+
24+
.. |pypi_version| image:: https://img.shields.io/pypi/v/orix.svg?style=flat
25+
:target: https://pypi.python.org/pypi/orix
26+
27+
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/orix.svg?logo=conda-forge&logoColor=white
28+
:target: https://anaconda.org/conda-forge/orix
1829

1930
.. |build_status| image:: https://github.com/pyxem/orix/workflows/build/badge.svg
20-
.. _build_status: https://github.com/pyxem/orix/actions
31+
:target: https://github.com/pyxem/orix/actions/workflows/build.yml
32+
33+
.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg
34+
:target: https://www.python.org/downloads/
2135

2236
.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/orix/badge.svg?branch=develop
23-
.. _Coveralls: https://coveralls.io/github/pyxem/orix?branch=develop
37+
:target: https://coveralls.io/github/pyxem/orix?branch=develop
2438

25-
.. |docs| image:: https://readthedocs.org/projects/orix/badge/?version=latest
26-
.. _docs: https://orix.readthedocs.io/en/latest
39+
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/orix.svg?label=PyPI%20downloads
40+
:target: https://pypi.org/project/orix/
2741

28-
.. |pypi_version| image:: https ://img.shields.io/pypi/v/orix.svg?style=flat
29-
.. _pypi_version: https://pypi.python.org/pypi/orix
42+
.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/orix.svg?label=Conda%20downloads
43+
:target: https://anaconda.org/conda-forge/orix
3044

31-
.. |downloads| image:: https://anaconda.org/conda-forge/orix/badges/downloads.svg
32-
.. _downloads: https://anaconda.org/conda-forge/orix
45+
.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3459662.svg
46+
:target: https://doi.org/10.5281/zenodo.3459662
3347

34-
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
35-
.. _black: https://github.com/psf/black
48+
.. |GPLv3| image:: https://img.shields.io/github/license/pyxem/orix
49+
:target: https://opensource.org/license/GPL-3.0
3650

37-
.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3459662.svg
38-
.. _doi: https://doi.org/10.5281/zenodo.3459662
51+
.. |GH-discuss| image:: https://img.shields.io/badge/GitHub-Discussions-green?logo=github
52+
:target: https://github.com/pyxem/orix/discussions
3953

40-
orix is an open-source Python library for analysing orientations and crystal symmetry.
54+
.. |binder| image:: https://mybinder.org/badge_logo.svg
55+
:target: https://mybinder.org/v2/gh/pyxem/orix/HEAD
4156

42-
The package defines objects and functions for the analysis of orientations represented
43-
as quaternions or 3D rotation vectors accounting for crystal symmetry. Functionality
44-
builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
45-
<https://matplotlib.org>`_ and is heavily inspired by the MATLAB package `MTEX
46-
<https://mtex-toolbox.github.io>`_.
57+
.. |docs| image:: https://readthedocs.org/projects/orix/badge/?version=latest
58+
:target: https://orix.readthedocs.io/en/latest
4759

48-
orix is released under the GPL v3 license.
60+
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
61+
:target: https://github.com/psf/black
62+
63+
+----------------------+------------------------------------------------+
64+
| Deployment | |pypi_version| |conda| |
65+
+----------------------+------------------------------------------------+
66+
| Build status | |build_status| |docs| |python| |
67+
+----------------------+------------------------------------------------+
68+
| Metrics | |Coveralls| |
69+
+----------------------+------------------------------------------------+
70+
| Activity | |pypi_downloads| |conda_downloads| |
71+
+----------------------+------------------------------------------------+
72+
| Citation | |doi| |
73+
+----------------------+------------------------------------------------+
74+
| License | |GPLv3| |
75+
+----------------------+------------------------------------------------+
76+
| Community | |GH-discuss| |
77+
+----------------------+------------------------------------------------+
78+
| Formatter | |black| |
79+
+----------------------+------------------------------------------------+
4980

5081
Documentation
5182
-------------
@@ -65,17 +96,17 @@ or ``conda``::
6596

6697
conda install orix -c conda-forge
6798

68-
You can also visit `PyPI <https://pypi.org/project/orix>`_, `Anaconda
69-
<https://anaconda.org/conda-forge/orix>`_ or `GitHub <https://github.com/pyxem/orix>`_
70-
to download the source.
99+
The source code is hosted in `GitHub <https://github.com/pyxem/orix>`_, and can also be
100+
downloaded from `PyPI <https://pypi.org/project/orix>`_ and
101+
`Anaconda <https://anaconda.org/conda-forge/orix>`_.
71102

72-
Further details are available in the `installation guide
73-
<https://orix.readthedocs.io/en/latest/user/installation.html>`_.
103+
Further details are available in the
104+
`installation guide <https://orix.readthedocs.io/en/latest/user/installation.html>`_.
74105

75106
Citing orix
76107
-----------
77108

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

Diff for: ‎doc/index.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ orix |release| documentation
55
orix is an open-source Python library for analysing orientations and crystal symmetry.
66

77
The package defines objects and functions for the analysis of orientations accounting
8-
for crystal symmetry. Functionality builds primarily on `NumPy <https://www.numpy.org>`_
9-
and `Matplotlib <https://matplotlib.org>`_, and is heavily inspired by the MATLAB
10-
package `MTEX <https://mtex-toolbox.github.io>`_.
8+
for crystal symmetry.
9+
Functionality builds primarily on `NumPy <https://www.numpy.org>`_ and `Matplotlib
10+
<https://matplotlib.org>`_.
11+
Initiation of the package was inspired by `MTEX <https://mtex-toolbox.github.io>`_.
1112

1213
.. toctree::
1314
:hidden:

0 commit comments

Comments
 (0)