Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make kikuchipy compatible with PyEBSDIndex 0.2 #652

Merged
merged 46 commits into from
Nov 3, 2023
Merged

Make kikuchipy compatible with PyEBSDIndex 0.2 #652

Changes from 1 commit
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
d8e47d3
Silence deprecation warnings from setuptools and traits
hakonanes Aug 6, 2023
b97fb24
Remove unnecessary figure decleration in EBSD.hough_indexing()
hakonanes Aug 6, 2023
d1ae018
Fix test for figures returned by PyEBSDIndex' indexing
hakonanes Aug 6, 2023
7e3a0e9
Update PC opt with PSO from PyEBSDIndex 0.2
hakonanes Aug 7, 2023
e63d909
Describe how to handle multiprocessing/ptest-xdist in dev docs
hakonanes Aug 7, 2023
84de5de
Require PyEBSDIndex >= 0.2
hakonanes Aug 7, 2023
289baec
Fix conversion between EDAX TSL <--> Bruker PC convensions
hakonanes Aug 8, 2023
77b2ee1
Use improved PC optimization w/ PSO from PyEBSDIndex 0.2 in HI tut.
hakonanes Aug 8, 2023
1bb1610
Use PC plane fitting in hybrid indexing tut. made possible by improve…
hakonanes Aug 8, 2023
88ebf90
Update reference frames tutorial using the fixed EDAX TSL PC conversion
hakonanes Aug 8, 2023
59004af
Make PC moving-screen calibration tutorial compat. w/PyEBSDIndex 0.2
hakonanes Aug 8, 2023
e75f951
Require PyEBSDIndex 0.2.*
hakonanes Aug 8, 2023
91e334b
Update orientation dep. on PC and PC plane fit tutorials
hakonanes Aug 9, 2023
2b58b83
Start to make EBSD HI methods compatible with PyEBSDIndex 0.2
hakonanes Aug 9, 2023
413b283
Start to make private HI functionality compatible with PyEBSDIndex 0.2
hakonanes Aug 9, 2023
8c9b16a
Rewrite similarity check for phase lists from orix and PyEBSDIndex
hakonanes Oct 25, 2023
989b1b2
Remove unnecessary test (was testing PyEBSDIndex, not kikuchipy)
hakonanes Oct 25, 2023
d4fc96b
Test passing reflector list in various forms, start on test for check…
hakonanes Oct 25, 2023
fb834b9
Complete tests of compatible phase lists and reflector lists
hakonanes Oct 29, 2023
0c92cf1
Improve HI tutorial
hakonanes Oct 29, 2023
3547c35
Improve hybrid indexing tutorial
hakonanes Oct 29, 2023
5a397b9
Improve detector-sample calibration tutorials
hakonanes Oct 31, 2023
d2129b9
Slightly improve wording in pattern matching tutorial
hakonanes Oct 31, 2023
4f8c230
Improve wording in reference frame tutorial
hakonanes Oct 31, 2023
a62e173
Update workshop tutorials
hakonanes Oct 31, 2023
2d56155
Try to use Trame backend instead of Panel in tutorials using PyVista
hakonanes Nov 1, 2023
29fed20
Replace Panel with Trame as PyVista backend in the docs
hakonanes Nov 1, 2023
ab9435f
Make PyVista 3D plots in docs static, as trame/nbpshinx does not work
hakonanes Nov 1, 2023
e3d2bff
Fix broken PR template links
hakonanes Nov 1, 2023
2294eee
Silence some warnings when building docs locally, improve make commands
hakonanes Nov 1, 2023
810e8be
Fix links in tutorials
hakonanes Nov 1, 2023
ec8b585
Capitalize DREAM.3D as the creators intended
hakonanes Nov 1, 2023
e5a30c8
Fix incorrect outlier detection in example, otherwise simplify exampl…
hakonanes Nov 1, 2023
3e91a04
Re-introduce virtual frame buffer in docs (because PyVista needs it?)
hakonanes Nov 1, 2023
dad8ba0
Merge branch 'develop' into support-pyebsdindex-0-2
hakonanes Nov 1, 2023
a05120f
Add build: html to RTD sphinx config
hakonanes Nov 1, 2023
69b644a
Install pandoc with aptitude on RTD server
hakonanes Nov 1, 2023
542da6c
Use pytest-rerunfailures to rerun flaky tests
hakonanes Nov 1, 2023
aefc94e
Install pandoc version supported by nbconvert on RTD
hakonanes Nov 1, 2023
95c1344
Re-introduce virtual frame buffer for PyVista on RTD
hakonanes Nov 1, 2023
f137df1
Mention possibility to set reflector lists for Hough indexing
hakonanes Nov 2, 2023
7bd0abe
Update doc/dev/running_writing_tests.rst
hakonanes Nov 2, 2023
3697def
Make it clear that comment lines and docstrings should be capped at 7…
hakonanes Nov 2, 2023
792a35d
Add @CSSFrancis to package credits
hakonanes Nov 2, 2023
6a8ff6b
Describe how to maintain package credits in the developer guide
hakonanes Nov 2, 2023
a794fe8
Remove reference to Twitter in code of conduct
hakonanes Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Make it clear that comment lines and docstrings should be capped at 7… 
…2 characters

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
  • Loading branch information
@hakonanes
hakonanes committed Nov 2, 2023
commit 3697defd98004d64f174d00d68ea2315b00ff372
3 changes: 2 additions & 1 deletion doc/dev/code_style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Note that ``black`` won't format `docstrings <https://peps.python.org/pep-0257/>
We follow the :doc:`numpydoc <numpydoc:format>` standard (with some exceptions), and the
docstrings are checked against this standard when building the documentation.

Comment lines should preferably be limited to 72 characters.
Comment and docstring lines should preferably be limited to 72 characters (including
leading whitespaces).

Package imports should be structured into three blocks with blank lines between them
(descending order): standard library (like ``os`` and ``typing``), third party packages
Expand Down