Functions for analysis of high resolution electron microscopy and spectroscopy data.
Functions for image and signal processing, based on the packages Scikit-image, Hyperspy, Atomap, PyPrismatic, ASE, periodictable etc. Written by members of the TEMUL group from the University of Limerick, Ireland (though we welcome all help, hints and contributions!)
Documentation & Installation
pip install temul-toolkit
For full installation instructions and documentation, go to temul-toolkit.readthedocs.io.
To use the vast majority of the
import it from the api module::
import temul.api as tml
To cite the TEMUL toolkit, use the following DOI:
Interactive Notebooks in the Browser
Jupyter Notebooks and MyBinder allow us to analyse data in the browser without needing any downloads using the below "launch binder" button.
If the button does not work, try this link instead. You also share this link with others for quick access.
To run through some code documentation tutorials, go to the "code_tutorials" folder after clicking the above button.
To analyse data published in the listed scientific papers, go to the "publication_examples" folder after clicking the above button.
|Publication Details||Folder Location in TEMUL|
|M. Hadjimichael, Y. Li et al, Metal-ferroelectric supercrystals with periodically curved metallic layers, Nature Materials 2021||publication_examples/PTO_supercrystal_hadjimichael|
|K. Moore et al Highly charged 180 degree head-to-head domain walls in lead titanate, Nature Communications Physics 2020||publication_examples/PTO_Junction_moore|
Information for developers
We use flake8 to enforce coding style:
pip install -r tests/requirements.txt flake8 temul flake8 tests flake8 docs
Tests are carried out with
pip install -r tests/requirements.txt pytest tests
To build the docs, do the following::
pip install -r docs/requirements.txt sphinx-build docs _build # open "index.html" in the "_build" directory
temul gets its version from the latest git tag. If you think that a
new version should be published, create a tag on the master branch
(if you have the necessary permissions to do so):
git tag -a 'x.y.z' -m 'new tag' git push --tags <remote>
GitHub Actions will then automatically build source package and wheels and publish them on PyPI.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for temul_toolkit-0.1.7-py3-none-any.whl