pyxem

An open-source Python library for multi-dimensional diffraction microscopy.

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README
✓
Academic publication links
Links to: arxiv.org, zenodo.org
✓
Committers with academic emails
17 of 44 committers (38.6%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary

Keywords

diffraction diffraction-analysis diffraction-tomography electron-diffraction hyperspy hyperspy-extension python

Keywords from Contributors

physics physics-simulation crystallography quaternion orientation texture electron-microscopy ebsd electron-backscatter-diffraction pattern-matching

Last synced: 6 months ago · JSON representation

Repository

An open-source Python library for multi-dimensional diffraction microscopy.

Basic Info

Host: GitHub
Owner: pyxem
License: gpl-3.0
Language: Python
Default Branch: main
Homepage: https://pyxem.readthedocs.io
Size: 17.9 MB

Statistics

Stars: 162
Watchers: 14
Forks: 88
Open Issues: 58
Releases: 34

Topics

diffraction diffraction-analysis diffraction-tomography electron-diffraction hyperspy hyperspy-extension python

Created about 10 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Zenodo

README.rst

|Actions|_ |Coveralls|_ |pypi_version|_ |downloads|_ |black|_ |doi|_

.. |Actions| image:: https://github.com/pyxem/pyxem/workflows/build/badge.svg
.. _Actions: https://github.com/pyxem/pyxem/actions

.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/pyxem/badge.svg?branch=main
.. _Coveralls: https://coveralls.io/github/pyxem/pyxem?branch=main

.. |pypi_version| image:: http://img.shields.io/pypi/v/pyxem.svg?style=flat
.. _pypi_version: https://pypi.python.org/pypi/pyxem

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2649351.svg
.. _doi: https://doi.org/10.5281/zenodo.2649351

.. |downloads| image:: https://anaconda.org/conda-forge/pyxem/badges/downloads.svg
.. _downloads: https://anaconda.org/conda-forge/pyxem

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
.. _black: https://github.com/psf/black

pyxem is an open-source (GPL v3) python library for multi-dimensional diffraction microscopy.

The package defines objects and functions for the analysis of numerous diffraction patterns. It has been primarily developed as a platform for hybrid diffraction-microscopy based on 4D scanning diffraction microscopy data in which a 2D diffraction pattern is recorded at every position in a 2D scan of a specimen.

pyxem is an extension of the hyperspy library for multi-dimensional data analysis and defines diffraction specific `Signal` classes.

**Installation instructions and tutorial examples are available** `here `__ .

**Basic Documentation is available** `here `__.

If analysis using pyxem forms a part of published work please cite the DOI at the top of this page. In addition to citing the package we would appreciate an additional citation to methods papers if you use the following capabilities:

Orientation Mapping
*******************

::

    @article{pyxemorientationmapping2022,
        title={Free, flexible and fast: Orientation mapping using the multi-core and GPU-accelerated template matching capabilities in the python-based open source 4D-STEM analysis toolbox Pyxem},
        author={Cautaerts, Niels and Crout, Phillip and {\AA}nes, H{\aa}kon Wiik and Prestat, Eric and Jeong, Jiwon and Dehm, Gerhard and Liebscher, Christian H},
        journal={Ultramicroscopy},
        pages={113517},
        year={2022},
        publisher={Elsevier},
        doi={10.1016/j.ultramic.2022.113517}
    }

Strain Mapping 
**************

*Two-Dimensional Strain Mapping with Scanning Precession Electron Diffraction: An Investigation into Data Analysis Routines* by Crout et al. 
which is freely avaliable at https://arxiv.org/abs/2307.01071

Owner

Name: pyxem
Login: pyxem
Kind: organization
Email: pyxem.team@gmail.com

Repositories: 9
Profile: https://github.com/pyxem

multi-dimensional diffraction microscopy

GitHub Events

Total

Create event: 3
Release event: 2
Issues event: 19
Watch event: 10
Member event: 1
Issue comment event: 103
Push event: 21
Pull request review comment event: 20
Pull request review event: 12
Pull request event: 32
Fork event: 2

Last Year

Create event: 3
Release event: 2
Issues event: 19
Watch event: 10
Member event: 1
Issue comment event: 103
Push event: 21
Pull request review comment event: 20
Pull request review event: 12
Pull request event: 32
Fork event: 2

Committers

Last synced: 9 months ago

All Time

Total Commits: 5,006
Total Committers: 44
Avg Commits per committer: 113.773
Development Distribution Score (DDS): 0.751

Past Year

Commits: 226
Committers: 7
Avg Commits per committer: 32.286
Development Distribution Score (DDS): 0.319

Top Committers

Name	Email	Commits
pc494	p**4@c**k	1,246
Duncan Johnstone	d**e@l**k	1,096
Carter Francis	c**s@w**u	733
Magnus Nord	m**r@g**m	494
Magnus Nord	M**d@g**k	237
JoonatanL	j**3@c**k	149
Simon Høgås	s**g@h**o	139
EirikOpheim	e**h@s**o	122
bm424	b**4@c**k	88
Eric Prestat	e**t@g**m	83
Tina Bergh	t**h@n**o	75
Viljar Femoen	v**n@h**o	62
Niels Cautaerts	n**s@h**m	58
Håkon Wiik Ånes	h**s@g**m	50
Stef Smeets	s**s@t**l	50
Andrew Ross	1**r@s**k	33
Joseph Broussard	b**4@g**m	32
Sivert Dagenborg	s**g@n**o	28
pre-commit-ci[bot]	6****]	26
Shuoyuan Huang	s**5@w**u	23
smc204	s**4@c**k	23
Tom Furnival	t**2@c**t	17
Daen Jannis	d**4@g**m	16
Ida	i**h@g**m	15
Mohsen	3****d	11
norskie	e**c@s**o	11
aaherzing	a**g@g**m	11
Danaie	m**e@d**k	11
timothy	t**6@g**m	10
Ruben Bjørge	r**e@s**o	6
and 14 more...

Committer Domains (Top 20 + Academic)

cam.ac.uk: 7 ntnu.no: 2 stud.ntnu.no: 2 hotmail.no: 2 wisc.edu: 2 inspiron.home: 1 gmail.com): 1 hotmail.co.uk: 1 sintef.no: 1 diamond.ac.uk: 1 cantab.net: 1 student.gla.ac.uk: 1 tudelft.nl: 1 glasgow.ac.uk: 1 live.co.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 117
Total pull requests: 296
Average time to close issues: 10 months
Average time to close pull requests: 22 days
Total issue authors: 31
Total pull request authors: 16
Average comments per issue: 4.28
Average comments per pull request: 3.73
Merged pull requests: 241
Bot issues: 1
Bot pull requests: 28

Past Year

Issues: 13
Pull requests: 38
Average time to close issues: about 1 month
Average time to close pull requests: 14 days
Issue authors: 10
Pull request authors: 5
Average comments per issue: 2.77
Average comments per pull request: 2.29
Merged pull requests: 22
Bot issues: 1
Bot pull requests: 3

View more stats

Top Authors

Issue Authors

CSSFrancis (43)
pc494 (19)
magnunor (7)
ericpre (6)
dnjohnstone (6)
emichr (3)
PVacek (3)
viljarjf (3)
tinabe (2)
opens21 (2)
sivborg (2)
rbjorge (2)
chrisallen80 (1)
AmoghMG (1)
iverks (1)

Pull Request Authors

CSSFrancis (147)
pc494 (70)
viljarjf (19)
pre-commit-ci[bot] (18)
ericpre (12)
github-actions[bot] (8)
sivborg (7)
hakonanes (3)
magnunor (2)
emichr (2)
chrisallen80 (2)
dependabot[bot] (2)
torit493 (1)
rbjorge (1)
SyHuang19 (1)

Top Labels

Issue Labels

dev (26) enhancement (15) discussion (14) bug (10) won't fix yet (9) deletion-candidate (7) question (5) feature suggestion (4) documentation (4) tests (3) easy_fix (2) 0.15 (2) status: stalled (1) 0.16.0 (1) status: WIP (1) waiting on author (1) 1.0.0 (1)

Pull Request Labels

needs review (38) dev (18) status: stalled (8) bug (5) waiting on author (5) enhancement (4) dependencies (4) breaking-change (4) 0.17.0 (4) documentation (3) status: WIP (3) 0.15 (3) 0.16.0 (2) deletion-candidate (2) Test Publish (1) tests (1) 1.0.0 (1)

Packages

Total packages: 2
Total downloads:
- pypi 6,113 last-month

Total dependent packages: 5
(may contain duplicates)
Total dependent repositories: 5
(may contain duplicates)
Total versions: 49
Total maintainers: 3

pypi.org: pyxem

multi-dimensional diffraction microscopy

Homepage: https://github.com/pyxem/pyxem
Documentation: https://pyxem.readthedocs.io/
License: GPLv3+
Latest release: 0.21.0
published 9 months ago

Versions: 31
Dependent Packages: 4
Dependent Repositories: 2
Downloads: 6,113 Last month

Rankings

Dependent packages count: 2.3%

Forks count: 4.9%

Stargazers count: 6.2%

Average: 6.3%

Downloads: 6.5%

Dependent repos count: 11.6%

Maintainers (3)

CSSFrancis dnjohnstone pc494

Last synced: 6 months ago

conda-forge.org: pyxem

Homepage: https://github.com/pyxem/pyxem
License: GPL-3.0-or-later
Latest release: 0.14.2
published over 3 years ago

Versions: 18
Dependent Packages: 1
Dependent Repositories: 3

Rankings

Dependent repos count: 18.0%

Forks count: 20.6%

Average: 24.8%

Dependent packages count: 29.0%

Stargazers count: 31.8%

Last synced: 6 months ago

Dependencies

.github/workflows/build.yml actions

AndreMiras/coveralls-python-action develop composite
actions/checkout v3 composite
actions/setup-python v2 composite

.github/workflows/python-publish.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

setup.py pypi

dask *
diffsims *
hyperspy *
ipywidgets *
lmfit *
matplotlib *
numba *
numpy *
orix *
psutil *
pyfai *
scikit-image *
scikit-learn *
scipy *
transforms3d *