ediff

Processing of electron diffraction patterns.

https://github.com/mirekslouf/ediff

Science Score: 57.0%

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

  • CITATION.cff file
    Found 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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Processing of electron diffraction patterns.

Basic Info
  • Host: GitHub
  • Owner: mirekslouf
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 5.29 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Citation

README.md

EDIFF :: processing electron diffraction patterns

  • EDIFF package:
    • processes an experimental 2D electron diffractogram (ELD)
    • calculates a theoretical X-ray diffractogram (XRD)
    • compares ELD and XRD to identify the structure
  • Powder vs. monocrystal diffractograms:
    • powder/polycrystal diffractograms - finished, working (see examples below)
    • monocrystal diffractograms - under development (not fully implemented yet)
  • If you use EDIFF in your research, please cite our recent paper:

Principle

EDIFF principle

Installation

  • Requirement: Python with sci-modules: numpy, matplotlib, scipy, pandas, pillow
  • pip install scikit-image = 3rd party package for advanced image processing
  • pip install pymatgen = 3rd party package employed in XRD calculations
  • pip install bground = our package, interactive background subtraction
  • pip install ediff = EDIFF package itself (uses all packages above)

Quick start

Documentation, help and examples

Versions of EDIFF

  • Version 0.0 = the 1st draft, testing of {pxrd} module
  • Version 0.1 = the 1st functional version with basic documentation
  • Version 0.2 = important improvements of {center} module
  • Version 0.3 = {calibration} module + various updates + better ediff template
  • Version 0.4 = {center} module: better structure + better funcs + saving coords
  • Version 0.5 = consolidation of code and documentation - all stable and working
  • Version 0.6 = finalization of {center} module
  • Version 0.7 = {gcryst} module: geometrical crystallography, zone axes ...
  • Version 1.0 = TODO: complete processing of powder diffractograms
  • Version 2.0 = TODO: complete processing of powder + monocrystal diffractograms

Acknowledgement

The development was co-funded by TACR, program NCK, project TN02000020.

Owner

  • Login: mirekslouf
  • Kind: user

Citation (CITATION)

If you use ediff package in your research, please cite:

Slouf M, Skoupy R, Pavlova E, Krzyzanek V:
High Resolution Powder Electron Diffraction in Scanning Electron Microscopy
Materials 14 (2011) 7550. https://doi.org/10.3390/ma14247550

Note: The paper describes {stemdiff} package; {ediff} is a part of it.

GitHub Events

Total
  • Issues event: 1
  • Delete event: 1
  • Push event: 46
  • Pull request event: 2
  • Create event: 2
Last Year
  • Issues event: 1
  • Delete event: 1
  • Push event: 46
  • Pull request event: 2
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mirekslouf (1)
Pull Request Authors
  • mirekslouf (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 145 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 13
  • Total maintainers: 1
pypi.org: ediff

Processing of powder electron diffraction patterns

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 145 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Forks count: 29.8%
Average: 32.2%
Stargazers count: 38.8%
Downloads: 60.6%
Maintainers (1)
Last synced: 6 months ago