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.

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

Prepare release of version 0.9.0 #659

Merged
merged 124 commits into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
124 commits
Select commit Hold shift + click to select a range
ac66a21
Update changelog following 0.8.0 release
hakonanes Feb 11, 2023
3c9e242
Update version from 0.8.0 to 0.9.dev0
hakonanes Feb 11, 2023
a7f8074
Update workflows with newest versions of actions
hakonanes Feb 11, 2023
844615b
Change which tutorials to run weekly
hakonanes Feb 11, 2023
0aef965
Update some tutorial notebooks to pass nbval check
hakonanes Feb 11, 2023
0f7d37a
Merge pull request #611 from hakonanes/main-into-develop-post-0.8.0
hakonanes Feb 11, 2023
8853191
Remove (deprecated) generators module
hakonanes Feb 11, 2023
fe91f3e
Remove deprecated projections module
hakonanes Feb 11, 2023
f1b2317
List removals in changelog
hakonanes Feb 11, 2023
11b55d7
Merge pull request #612 from hakonanes/remove-deprecated-functionality
hakonanes Feb 11, 2023
8226b9c
Fix test error with optional dependency not installed
ericpre Feb 12, 2023
c60d443
Merge pull request #613 from ericpre/fix_test_optional_dependency
hakonanes Feb 12, 2023
c7d788a
Revert release version from 0.8.1 to 0.8.dev0
hakonanes Feb 20, 2023
8b07f45
Update changelog following 0.8.1 release
hakonanes Feb 20, 2023
d59a4ea
Update workflow action versions
hakonanes Feb 20, 2023
edd014f
Update release action to softprops
hakonanes Feb 20, 2023
cbd808b
Merge branch 'develop' into main-into-develop-post-0.8.1
hakonanes Feb 20, 2023
550c305
Merge pull request #617 from hakonanes/main-into-develop-post-0.8.1
hakonanes Feb 20, 2023
904997f
Merge branch 'develop' into main-into-develop-post-0.8.2-release
hakonanes Mar 14, 2023
e237eb0
Simplify release guide slightly
hakonanes Mar 14, 2023
188b301
Merge pull request #624 from hakonanes/main-into-develop-post-0.8.2-r…
hakonanes Mar 14, 2023
5922431
Use imgconverter Sphinx extension for SVG conversion for PDF build
hakonanes Mar 15, 2023
34ba0fc
Install imagemagick on RTD server, required by imgconverter
hakonanes Mar 15, 2023
3da6e23
Make micron Unicode character a "u" in doc PDF
hakonanes Mar 15, 2023
e5d037b
Temporarily disable PDF build (fails without a clear cause)
hakonanes Mar 16, 2023
f463aa1
Merge pull request #625 from hakonanes/fix-rtd-pdf-build
hakonanes Mar 16, 2023
635324b
Merge branch 'develop' into main-to-develop-post-0.8.3-release
hakonanes Mar 23, 2023
f4a66be
Merge pull request #629 from hakonanes/main-to-develop-post-0.8.3-rel…
hakonanes Mar 23, 2023
0be6614
Merge branch 'develop' into main-into-develop-post-0.8.4
hakonanes Apr 7, 2023
b7a7102
Update package description in constant release draft text
hakonanes Apr 7, 2023
a84fbd6
"Thanks go to" instead of "Thanks goes to"
hakonanes Apr 7, 2023
e68cdf1
Merge pull request #635 from hakonanes/main-into-develop-post-0.8.4
hakonanes Apr 7, 2023
657e4ac
Merge branch 'develop' into main-into-develop-post-0.8.5
hakonanes May 21, 2023
37400b5
Merge pull request #640 from hakonanes/main-into-develop-post-0.8.5
hakonanes May 21, 2023
ffc57a3
Merge branch 'develop' into main-into-develop-after-0.8.6
hakonanes May 29, 2023
d6cb124
Merge pull request #642 from hakonanes/main-into-develop-after-0.8.6
hakonanes May 29, 2023
3067697
Improve color handling via kwargs in geo. sim. as_collections()
hakonanes Jun 8, 2023
6017d08
Remove deprecated PyPI selector [viz]
hakonanes Jun 8, 2023
ab093c0
Re-enable doc PDF build
hakonanes Jun 8, 2023
cf66e62
Update authentication in publish workflow to 'trusted publisher'
hakonanes Jun 8, 2023
968ee19
Merge pull request #643 from hakonanes/some-maintenance
hakonanes Jun 9, 2023
716f926
Merge branch 'develop' into main-into-develop-after-0.8.7
hakonanes Jul 24, 2023
fd5d9c0
Merge pull request #649 from hakonanes/main-into-develop-after-0.8.7
hakonanes Jul 24, 2023
e9137ac
List explicit support for Python 3.11
hakonanes Jul 23, 2023
5f8c6f0
List explicit support for Python 3.11 in changelog
hakonanes Jul 23, 2023
04034cc
Use Python 3.11 to build docs on readthedocs
hakonanes Jul 23, 2023
b84c00e
Make Binder use Python 3.11
hakonanes Jul 23, 2023
6bebe71
Replace Python 3.9 test run with 3.11
hakonanes Jul 23, 2023
ba3cf7b
Use Python 3.11 when running nbval to test notebooks
hakonanes Jul 23, 2023
2fb6614
Fix link to dark logo in docs
hakonanes Jul 23, 2023
462f973
Minor updates to versions, application paper links and related proj.
hakonanes Jul 23, 2023
565c430
Increase minimal versions of diffsims, NumPy and Matplotlib
hakonanes Jul 23, 2023
3e0c8c0
Merge pull request #646 from hakonanes/python-3-11-support
hakonanes Jul 24, 2023
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
8e2aa63
A suggestion for updating the documentation with RBGA image navigation
AndreasBugten Aug 28, 2023
141d9d3
Delete test.txt
AndreasBugten Aug 28, 2023
5397ed5
Update to tutorial
AndreasBugten Aug 28, 2023
560ca63
Merge branch 'kikuchidev' of https://github.com/AndreasBugten/kikuchi…
AndreasBugten Aug 28, 2023
03e0469
update to tutorial
AndreasBugten Aug 29, 2023
fb8fcf3
fixed comma issues
AndreasBugten Aug 29, 2023
ed4b117
testing \n
AndreasBugten Aug 29, 2023
c5f900c
fixed punctuation error
AndreasBugten Aug 29, 2023
a761ae9
Split RGBA map cell into two and update description slightly
hakonanes Aug 29, 2023
b240346
Add @AndreasBugten to package credits
hakonanes Aug 29, 2023
b7d626c
Merge pull request #653 from AndreasBugten/kikuchidev
hakonanes Aug 29, 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
7e0425a
Merge pull request #652 from hakonanes/support-pyebsdindex-0-2
hakonanes Nov 3, 2023
c7be8a0
Fix downloading files from data modules to local cache on Windows
hakonanes Nov 3, 2023
67d5be8
Add changelog entry
hakonanes Nov 3, 2023
f5b79b9
Add bug report to ways @ericpre has contributed
hakonanes Nov 3, 2023
bde4cd0
Merge pull request #655 from hakonanes/fix-654
hakonanes Nov 3, 2023
f9e1095
Restrict HyperSpy to below version 2 (for the moment)
hakonanes Nov 3, 2023
5335f88
Add changelog entry
hakonanes Nov 3, 2023
e998454
Remove deprecated datasets of silicon EBSPs for moving-screen technique
hakonanes Nov 3, 2023
a4a195c
Add changelog entry
hakonanes Nov 3, 2023
6f69722
Merge pull request #656 from hakonanes/remove-unused-functions
hakonanes Nov 3, 2023
1ba98e6
Merge pull request #657 from hakonanes/pin-hyperspy-before-2.0
hakonanes Nov 3, 2023
34e2a83
Sort contributors by line contributions (including notebooks...)
hakonanes Nov 3, 2023
3d010a5
Set version to 0.9.0
hakonanes Nov 3, 2023
977887d
Review and clean up changelog for release
hakonanes Nov 3, 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
12 changes: 6 additions & 6 deletions .github/workflows/perhaps_make_tagged_release_draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v1
- uses: r-lib/actions/setup-pandoc@v2

- name: Set up Python ${{ runner.python-version }}
uses: actions/setup-python@v4
Expand All @@ -43,13 +43,13 @@ jobs:

- name: Make tagged release draft
if: ${{ env.MAKE_RELEASE == 'true' }}
uses: actions/create-release@v1
uses: softprops/action-gh-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
draft: true
tag_name: v${{ env.BRANCH_VERSION }}
release_name: kikuchipy ${{ env.BRANCH_VERSION }}
commitish: main
body_path: release_part_in_changelog.md
draft: true
prerelease: false
name: kikuchipy ${{ env.BRANCH_VERSION }}
tag_name: v${{ env.BRANCH_VERSION }}
target_commitish: main
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ jobs:
python -m build

- name: Publish package to TestPyPI
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
uses: pypa/gh-action-pypi-publish@release/v1
continue-on-error: true
with:
user: __token__
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
repository_url: https://test.pypi.org/legacy/

- name: Publish package to PyPI
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
16 changes: 9 additions & 7 deletions .github/workflows/test_documentation_notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ on:
workflow_dispatch:
workflow: "*"

env:
MPLBACKEND: agg

jobs:
test-documentation-notebooks:
runs-on: ubuntu-latest
timeout-minutes: 30
env:
MPLBACKEND: agg
steps:
- uses: actions/checkout@v3

Expand All @@ -20,17 +21,18 @@ jobs:
with:
python-version: '3.10'

- name: Display versions
run: |
python -V
pip -V

- name: Install package and dependencies
shell: bash
run: |
pip install -U -e .'[doc,tests,all]'
pip install -U nbval pyopencl

- name: Display Python, pip and package versions
run: |
python -V
pip -V
pip list

- name: Test documentation notebooks
run: |
./doc/tutorials/run_nbval.sh
14 changes: 14 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ Removed
Fixed
-----

Security
--------

0.8.1 (2023-02-20)
==================

Fixed
-----
- Hough indexing with PyEBSDIndex of a lazy EBSD signal requires not only PyOpenCL to be
installed, but also for PyOpenCL to be able to create a context.
(`#615 <https://github.com/pyxem/kikuchipy/pull/615>`_)
- Missing progressbars for ``EBSD`` methods ``average_neighbour_patterns()`` and
``fft_filter()`` reintroduced. (`#615 <https://github.com/pyxem/kikuchipy/pull/615>`_)

0.8.0 (2023-02-11)
==================

Expand Down
9 changes: 2 additions & 7 deletions kikuchipy/signals/tests/test_ebsd_hough_indexing.py
Original file line number Diff line number Diff line change
Expand Up @@ -267,15 +267,10 @@ def test_optimize_pc_raises(self):
[0.5, 0.5, 0.5], self.indexer, method="PSO", batch=True
)

def test_optimize_pc_lazy(self):
def test_optimize_pc_lazy(self): # pragma: no cover
s = self.signal.as_lazy()

from pyebsdindex import _pyopencl_installed

if not _pyopencl_installed:
with pytest.raises(ValueError, match="Hough indexing of lazy signals must"):
_ = s.hough_indexing_optimize_pc(self.detector.pc_average, self.indexer)
else: # pragma: no cover
if kp._pyopencl_context_available:
det = s.hough_indexing_optimize_pc(self.detector.pc_average, self.indexer)
assert np.allclose(det.pc_average, self.detector.pc_average, atol=1e-2)
else:
Expand Down