Data

Tools

Indexes

Applications

Experiments

Open Source Science

scikit-ued

Collection of algorithms and routines for (ultrafast) electron diffraction and scattering

https://github.com/laurentrdc/scikit-ued

Science Score: 36.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
  • ✓
    DOI references
    Found 7 DOI reference(s) in README
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.3%) to scientific vocabulary

Keywords

diffraction electron-microscopy python science scikit ultrafast-electron
Last synced: 6 months ago · JSON representation

Repository

Collection of algorithms and routines for (ultrafast) electron diffraction and scattering

Basic Info
Statistics
  • Stars: 145
  • Watchers: 8
  • Forks: 21
  • Open Issues: 0
  • Releases: 34
Topics
diffraction electron-microscopy python science scikit ultrafast-electron
Created almost 9 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License

README.md

scikit-ued

Documentation Build Status PyPI Version Conda-forge Version DOI badge

Collection of algorithms and functions for ultrafast electron diffraction. It aims to be a fully-tested package taking advantage of Python's most recent features.

For examples, see our tutorials.

API Reference

The API Reference on readthedocs.io provides API-level documentation, as well as tutorials.

Installation

scikit-ued is available on PyPI; it can be installed with pip:

python -m pip install scikit-ued

To also install optional dependencies required to view diffraction images interactively:

python -m pip install scikit-ued[diffshow]

scikit-ued is also available on the conda-forge channel for the conda package manager:

conda config --add channels conda-forge
conda install scikit-ued

To install the latest development version from Github:

python -m pip install git+https://github.com/LaurentRDC/scikit-ued.git

After installing scikit-ued you can use it like any other Python module as skued.

Each version is tested against Python 3.7+. If you are using a different version, tests can be run using the pytest package.

Optional dependencies

For displaying diffraction images with interactive contrast using the skued.diffshow function, PyQtGraph is required.

Contributing

If you want to contribute to scikit-ued, take a look at CONTRIBUTING.md.

Related projects

Streaming operations on NumPy arrays are available in the npstreams package.

Interactive exploration of ultrafast electron diffraction data with the iris-ued package.

Crystal structure manipulation (including symmetry-determination) with the crystals package. (Included with scikit-ued)

A graphical user interface for the dual-tree complex wavelet transform baseline-removal routine is available as a separate package.

Citations

If you find this software useful, please consider citing the following publication:

L. P. René de Cotret, M. R. Otto, M. J. Stern. and B. J. Siwick, An open-source software ecosystem for the interactive exploration of ultrafast electron scattering data, Advanced Structural and Chemical Imaging 4:11 (2018) DOI: 10.1186/s40679-018-0060-y.

If you are using the baseline-removal functionality of scikit-ued, please consider citing the following publication:

L. P. René de Cotret and B. J. Siwick, A general method for baseline-removal in ultrafast electron powder diffraction data using the dual-tree complex wavelet transform, Struct. Dyn. 4 (2017) DOI: 10.1063/1.4972518.

Support / Report Issues

All support requests and issue reports should be filed on Github as an issue.

License

scikit-ued is made available under the GPLv3 License. For more details, see LICENSE.txt.

Owner

  • Name: Laurent P. René de Cotret
  • Login: LaurentRDC
  • Kind: user
  • Location: Montréal
  • Company: @bitnomial

Scientific computing, functional programming, and hardtech innovation. Board member of the @haskellfoundation

GitHub Events

Total
  • Release event: 1
  • Watch event: 10
  • Push event: 7
  • Fork event: 1
  • Create event: 1
Last Year
  • Release event: 1
  • Watch event: 10
  • Push event: 7
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 4,969
  • Total Committers: 4
  • Avg Commits per committer: 1,242.25
  • Development Distribution Score (DDS): 0.001
Past Year
  • Commits: 11
  • Committers: 2
  • Avg Commits per committer: 5.5
  • Development Distribution Score (DDS): 0.091
Top Committers
Name Email Commits
Laurent P. René de Cotret l****t@o****m 4,965
Laurenz Kremeyer l****r@m****a 2
Tristan Britt 5****t 1
OliDG 3****G 1
Committer Domains (Top 20 + Academic)
mail.mcgill.ca: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 11
  • Total pull requests: 35
  • Average time to close issues: 15 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 8
  • Total pull request authors: 6
  • Average comments per issue: 3.73
  • Average comments per pull request: 0.66
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 19 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 5.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • zxdawn (2)
  • KOLANICH (2)
  • LittleLyon (2)
  • davidsaroff (1)
  • niki200481 (1)
  • OliDG (1)
  • grahamsno (1)
  • LaurentRDC (1)
Pull Request Authors
  • LaurentRDC (29)
  • kremeyer (2)
  • KOLANICH (1)
  • OliDG (1)
  • pyup-bot (1)
  • trbritt (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,431 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 3
    (may contain duplicates)
  • Total versions: 66
  • Total maintainers: 1
pypi.org: scikit-ued

Collection of algorithms and functions for ultrafast electron scattering

  • Versions: 43
  • Dependent Packages: 1
  • Dependent Repositories: 3
  • Downloads: 1,431 Last month
  • Docker Downloads: 0
Rankings
Docker downloads count: 4.2%
Dependent packages count: 4.7%
Stargazers count: 6.5%
Average: 7.8%
Forks count: 8.9%
Dependent repos count: 9.0%
Downloads: 13.5%
Maintainers (1)
LaurentRDC
Last synced: 6 months ago
conda-forge.org: scikit-ued

Collection of algorithms and functions for ultrafast electron diffraction.

  • Versions: 23
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 28.8%
Stargazers count: 31.4%
Average: 33.1%
Dependent repos count: 34.0%
Forks count: 38.1%
Last synced: 6 months ago

Dependencies

dev-requirements.txt pypi
  • Sphinx >=3 development
  • black * development
  • cython >=0.25 development
  • pytest >=6 development
  • sphinx_rtd_theme >=0.4 development
  • wheel * development
requirements.txt pypi
  • crystals >=1.3.1,<2
  • matplotlib >=3.0.0,<4
  • npstreams >=1.6.5,<2
  • numpy >=1.17,<2
  • pywavelets >=1.0.0,<2
  • pyyaml >=3.1
  • scikit-image >=0.19,<1
  • scipy >=1.5.0,<2
.github/workflows/ci.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • softprops/action-gh-release v1 composite
.github/workflows/lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • psf/black stable composite