Merge 99647e8 into 41c1640

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!-- Taken from the napari project https://raw.githubusercontent.com/napari/napari/master/.github/PULL_REQUEST_TEMPLATE.md -->
+
+# Description
+<!-- What does this pull request (PR) do? Why is it necessary? -->
+<!-- Tell us about your new feature, improvement, or fix! -->
+
+## Type of change
+<!-- Please delete options that are not relevant. -->
+- [ ] Bug-fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# References
+<!-- What resources, documentation, and guides were used in the creation of this PR? -->
+<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->
+
+# How has this been tested?
+<!-- Please describe the tests that you ran to verify your changes. -->
+- [ ] example: the test suite for my feature covers cases x, y, and z
+- [ ] example: all tests pass with my change
+
+## Final checklist:
+- [ ] My PR is the minimum possible work for the desired functionality
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works

README.md

@@ -29,6 +29,11 @@ Everyone is welcome to contribute. Please read our
 [contributor guide](https://kikuchipy.readthedocs.io/en/latest/contributing.html)
 to get started!
 
+### Code of Conduct
+
+KikuchiPy has a [Code of Conduct](https://github.com/kikuchipy/kikuchipy/blob/master/doc/code_of_conduct.rst)
+that should be honoured by everyone who participates in the KikuchiPy community.
+
 ### Cite
 
 If analysis using KikuchiPy forms a part of published work, please consider

doc/background_correction.rst

@@ -154,5 +154,5 @@ range, either keeping relative intensities between patterns or not, by using
     :align: center
     :width: 350
 
-    Same pattern as in :ref:`the above figure <fig-pattern-adapthist-uint16>` with
-    intensities rescaled to fill the full ``uint16`` data range.
+    Same pattern as in :ref:`the above figure <fig-pattern-adapthist-uint16>`
+    with intensities rescaled to fill the full ``uint16`` data range.

doc/change_scan_pattern_size.rst

@@ -68,4 +68,5 @@ passing in either the ``scale`` or ``new_shape`` parameter:
 Note that :meth:`~kikuchipy-signals.ebsd.EBSD.rebin` casts the data to
 ``uint64``. This means that in this example, each pixel in the binned scan
 ``s3`` takes up eight times the memory size of pixels in the original scan
-``s``.
+``s``. If you want, you can :ref:`rescale the intensities <rescale-intensities>`
+to e.g. the ``uint8`` data type range.

doc/index.rst

@@ -2,6 +2,26 @@
 KikuchiPy
 =========
 
+|travis-ci|_ |coveralls|_ |doc|_  |pypi_version|_  |doi|_ |black|_
+
+.. |travis-ci| image:: https://api.travis-ci.org/kikuchipy/kikuchipy.svg?branch=master
+.. _travis-ci: https://travis-ci.org/kikuchipy/kikuchipy
+
+.. |coveralls| image:: https://coveralls.io/repos/github/kikuchipy/kikuchipy/badge.svg?branch=master
+.. _coveralls: https://coveralls.io/github/kikuchipy/kikuchipy?branch=master
+
+.. |doc| image:: https://readthedocs.org/projects/kikuchipy/badge/?version=latest
+.. _doc: https://kikuchipy.readthedocs.io
+
+.. |pypi_version| image:: http://img.shields.io/pypi/v/kikuchipy.svg?style=flat
+.. _pypi_version: https://pypi.python.org/pypi/kikuchipy
+
+.. |doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.3597646.svg
+.. _doi: https://doi.org/10.5281/zenodo.3597646
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+.. _black: https://github.com/psf/black
+
 *KikuchiPy is an open-source Python library for processing and analysis of
 electron backscatter diffraction (EBSD) patterns.*
 
@@ -11,6 +31,9 @@ class, which has several common methods for processing of EBSD patterns, also
 inherits all relevant methods from HyperSpy's Signal2D and `Signal
 <https://hyperspy.org/hyperspy-doc/current/user_guide/tools.html>`_ classes.
 
+Note that the project is in an alpha stage, and there will likely be breaking
+changes with each release.
+
 KikuchiPy is released under the GPL v3 license.
 
 .. toctree::
@@ -42,9 +65,3 @@ KikuchiPy is released under the GPL v3 license.
     cite.rst
     related_projects.rst
     Code of Conduct <code_of_conduct.rst>
-
-Acknowledgement
-===============
-
-Initial work from Håkon Wiik Ånes was funded by the NAPIC project (NTNU
-Aluminium Product Innovation Center).

doc/visualizing_patterns.rst

@@ -34,7 +34,7 @@ corresponding to the sum of all detector intensities within that pattern:
     :align: center
     :width: 100%
 
-    Example of a standard navigator map (right), and the detector (right). This
+    Example of a standard navigator map (right), and the detector (left). This
     is the standard view when calling ``s.plot()``.
 
 However, any :class:`~hyperspy.signal.BaseSignal` object with a
@@ -151,7 +151,7 @@ as a visual inspection of the indexing results:
     >>> with h5py.File('/path/to/simulated_patterns/sim.h5', mode='r') as f:
             patterns = f['EMData/EBSD/EBSDPatterns'][()]
     >>> s_sim = kp.signals.EBSD(patterns.reshape(s.axes_manager.shape))
-    >>> hs.plot.plot_signals([s, s_sim])
+    >>> hs.plot.plot_signals([s, s_sim], navigator=s_om)
 
 .. _fig-plot-multiple-scans: