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
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Remove reference to Twitter in code of conduct
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
  • Loading branch information
hakonanes committed Nov 2, 2023
commit a794fe88459cac2ac94338df179f5c2d1c8f41dd
193 changes: 100 additions & 93 deletions CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,134 +5,141 @@ kikuchipy Code of Conduct
Introduction
============

This code of conduct applies to all spaces managed by the kikuchipy project,
including all public and private mailing lists, issue trackers, wikis, blogs,
Twitter, and any other communication channel used by our community. The
kikuchipy project does not organise in-person events, however events related to
our community should have a code of conduct similar in spirit to this one.

This code of conduct should be honoured by everyone who participates in the
kikuchipy community formally or informally, or claims any affiliation with the
project, in any project-related activities and especially when representing the
project, in any role.

This code is not exhaustive or complete. It serves to distill our common
understanding of a collaborative, shared environment and goals. Please try to
follow this code in spirit as much as in letter, to create a friendly and
This code of conduct applies to all spaces managed by the kikuchipy project, including
all public and private mailing lists, issue trackers, wikis, blogs, and any other
communication channel used by our community.
The kikuchipy project does not organise in-person events, however events related to our
community should have a code of conduct similar in spirit to this one.

This code of conduct should be honoured by everyone who participates in the kikuchipy
community formally or informally, or claims any affiliation with the project, in any
project-related activities and especially when representing the project, in any role.

This code is not exhaustive or complete. It serves to distill our common understanding
of a collaborative, shared environment and goals.
Please try to follow this code in spirit as much as in letter, to create a friendly and
productive environment that enriches the surrounding community.

Specific guidelines
===================

We strive to:

1. Be open. We invite anyone to participate in our community. We prefer to use
public methods of communication for project-related messages, unless
discussing something sensitive. This applies to messages for help or
project-related support, too; not only is a public-support request much more
likely to result in an answer to a question, it also ensures that any
inadvertent mistakes in answering are more easily detected and corrected.

2. Be empathetic, welcoming, friendly, and patient. We work together to resolve
conflict, and assume good intentions. We may all experience some frustration
from time to time, but we do not allow frustration to turn into a personal
attack. A community where people feel uncomfortable or threatened is not a
productive one.

3. Be collaborative. Our work will be used by other people, and in turn we will
depend on the work of others. When we make something for the benefit of the
project, we are willing to explain to others how it works, so that they can
build on the work to make it even better. Any decision we make will affect
users and colleagues, and we take those consequences seriously when making
decisions.

4. Be inquisitive. Nobody knows everything! Asking questions early avoids many
problems later, so we encourage questions, although we may direct them to the
appropriate forum. We will try hard to be responsive and helpful.

5. Be careful in the words that we choose. We are careful and respectful in our
communication and we take responsibility for our own speech. Be kind
others. Do not insult or put down other participants. We will not accept
harassment or other exclusionary behaviour, such as:
1. Be open.
We invite anyone to participate in our community.
We prefer to use public methods of communication for project-related messages, unless
discussing something sensitive.
This applies to messages for help or project-related support, too; not only is a
public-support request much more likely to result in an answer to a question, it also
ensures that any inadvertent mistakes in answering are more easily detected and
corrected.

2. Be empathetic, welcoming, friendly, and patient.
We work together to resolve conflict, and assume good intentions.
We may all experience some frustration from time to time, but we do not allow
frustration to turn into a personal attack.
A community where people feel uncomfortable or threatened is not a productive one.

3. Be collaborative.
Our work will be used by other people, and in turn we will depend on the work of
others.
When we make something for the benefit of the project, we are willing to explain to
others how it works, so that they can build on the work to make it even better.
Any decision we make will affect users and colleagues, and we take those consequences
seriously when making decisions.

4. Be inquisitive.
Nobody knows everything!
Asking questions early avoids many problems later, so we encourage questions,
although we may direct them to the appropriate forum.
We will try hard to be responsive and helpful.

5. Be careful in the words that we choose.
We are careful and respectful in our communication and we take responsibility for our
own speech.
Be kind others.
Do not insult or put down other participants.
We will not accept harassment or other exclusionary behaviour, such as:

- Violent threats or language directed against another person.
- Sexist, racist, ableist, or otherwise discriminatory jokes and language.
- Posting sexually explicit or violent material.
- Posting (or threatening to post) other people's personally identifying
information ("doxing").
- Sharing private content, such as emails sent privately or non-publicly, or
unlogged forums such as IRC channel history, without the sender's consent.
- Posting (or threatening to post) other people's personally identifying information
("doxing").
- Sharing private content, such as emails sent privately or non-publicly, or unlogged
forums such as IRC channel history, without the sender's consent.
- Personal insults, especially those using racist, sexist, or ableist terms.
- Intentional or repeated misgendering of participants who have explicitly
requested to be addressed by specific pronouns.
- Intentional or repeated misgendering of participants who have explicitly requested
to be addressed by specific pronouns.
- Unwelcome sexual attention.
- Excessive profanity. Please avoid swearwords; people differ greatly in
their sensitivity to swearing.
- Repeated harassment of others. In general, if someone asks you to stop,
then stop.
- Excessive profanity.
Please avoid swearwords; people differ greatly in their sensitivity to swearing.
- Repeated harassment of others.
In general, if someone asks you to stop, then stop.
- Advocating for, or encouraging, any of the above behaviour.

Diversity statement
===================

The kikuchipy project welcomes and encourages participation by everyone. We are
committed to being a community that everyone enjoys being part of. Although we
may not always be able to accommodate each individual's preferences, we try our
best to treat everyone kindly.
The kikuchipy project welcomes and encourages participation by everyone.
We are committed to being a community that everyone enjoys being part of.
Although we may not always be able to accommodate each individual's preferences, we try
our best to treat everyone kindly.

No matter how you identify yourself or how others perceive you: we welcome you.
Though no list can hope to be comprehensive, we explicitly honour diversity in:
age, culture, ethnicity, genotype, gender identity or expression, language,
national origin, neurotype, phenotype, political beliefs, profession, race,
religion, sexual orientation, socioeconomic status, subculture and technical
ability, to the extent that these do not conflict with this code of conduct.
Though no list can hope to be comprehensive, we explicitly honour diversity in: age,
culture, ethnicity, genotype, gender identity or expression, language, national origin,
neurotype, phenotype, political beliefs, profession, race, religion, sexual orientation,
socioeconomic status, subculture and technical ability, to the extent that these do not
conflict with this code of conduct.

Though we welcome people fluent in all languages, kikuchipy development is
conducted in English.
Though we welcome people fluent in all languages, kikuchipy development is conducted in
English.

Standards for behaviour in the kikuchipy community are detailed in the Code of
Conduct above. Participants in our community should uphold these standards in
all their interactions and help others to do so as well (see next section).
Standards for behaviour in the kikuchipy community are detailed in the Code of Conduct
above.
Participants in our community should uphold these standards in all their interactions
and help others to do so as well (see next section).

Reporting guidelines
====================

We know that it is painfully common for internet communication to start at or
devolve into obvious and flagrant abuse. We also recognize that sometimes people
may have had a bad day, or be unaware of some of the guidelines in this Code of
Conduct. Please keep this in mind when deciding how to respond to a breach of
this Code.
We know that it is painfully common for internet communication to start at or devolve
into obvious and flagrant abuse.
We also recognize that sometimes people may have had a bad day, or be unaware of some of
the guidelines in this Code of Conduct.
Please keep this in mind when deciding how to respond to a breach of this Code.

For clearly intentional breaches, report those to the Code of Conduct Committee
(see below). For possibly unintentional breaches, you may reply to the person
and point out this Code of Conduct (either in public or in private, whatever is
most appropriate). If you would prefer not to do that, please feel free to
report to the code of conduct committee directly, or ask the committee for
advice, in confidence.
For clearly intentional breaches, report those to the Code of Conduct Committee (see
below).
For possibly unintentional breaches, you may reply to the person and point out this Code
of Conduct (either in public or in private, whatever is most appropriate).
If you would prefer not to do that, please feel free to report to the code of conduct
committee directly, or ask the committee for advice, in confidence.

You can report issues to the kikuchipy Code of Conduct Committee, at
kikuchipy-conduct@googlegroups.com. Currently, the committee consists of:
kikuchipy-conduct@googlegroups.com.
Currently, the committee consists of:

* `Håkon Wiik Ånes <https://github.com/hakonanes>`_ (chair)
* `Tina Bergh <https://github.com/tinabe>`_

Incident reporting resolution & Code of Conduct enforcement
===========================================================

*This section summarizes the most important points, more details can be found
in* :doc:`report_handling_manual`.
*This section summarizes the most important points, more details can be found in*
:doc:`report_handling_manual`.

We will investigate and respond to all complaints. The kikuchipy Code of Conduct
Committee will protect the identity of the reporter, and treat the content of
complaints as confidential (unless the reporter agrees otherwise).
We will investigate and respond to all complaints.
The kikuchipy Code of Conduct Committee will protect the identity of the reporter, and
treat the content of complaints as confidential (unless the reporter agrees otherwise).

In case of severe and obvious breaches, e.g. personal threat or violent,
sexist or racist language, we will immediately disconnect the originator from
kikuchipy communication channels; please see the manual for details.
In case of severe and obvious breaches, e.g. personal threat or violent, sexist or
racist language, we will immediately disconnect the originator from kikuchipy
communication channels; please see the manual for details.

In cases not involving clear severe and obvious breaches of this code of
conduct, the process for acting on any received code of conduct violation report
will be:
In cases not involving clear severe and obvious breaches of this code of conduct, the
process for acting on any received code of conduct violation report will be:

1. acknowledge report is received

Expand All @@ -144,14 +151,14 @@ will be:
4. enforcement via transparent decision (see :ref:`resolutions`) by the Code of
Conduct Committee

The committee will respond to any report as soon as possible, and at most within
72 hours.
The committee will respond to any report as soon as possible, and at most within 72
hours.

Endnotes
========

We are thankful to the groups behind the following documents, from which we drew
content and inspiration:
We are thankful to the groups behind the following documents, from which we drew content
and inspiration:

* `napari Code of Conduct <https://napari.org/community/code_of_conduct.html>`_
* `NumPy Code of Conduct <https://numpy.org/code-of-conduct>`_
Loading