Skip to main content

Python Template Matching Engine

Project description

Python Template Matching Engine (PyTME)

Build Status PyPI

Documentation | Installation | API

PyTME is a Python library for data-intensive n-dimensional template matching using CPUs and GPUs.

With its backend-agnostic design, the same code can be run on diverse hardware platforms using a best-of-breed approach. The underyling abstract backend specification allows for adding new backends to benefit from gains in performance and capabilities without modifying the library's core routines. The implementation of template matching scores is modular and provides developers with a flexible framework for rapid prototyping. Furthermore, pyTME supports a unique callback capability through analyzers, which allows for injection of custom code, enabling real-time processing and manipulation of results.

PyTME includes a graphical user interface that provides simplified mask creation, interactive filter exploration, result visualization, and manual refinement capabilities. This GUI serves as an accessible entry point to the library's core functionalities, allowing users to efficiently interact with and analyze their data.

Finally, pyTME offers specialized tools for cryogenic electron microscopy data, such as wedge masks, CTF correction, as well as means for handling structural data. Through dedicated integrations, the output of pyTME seamlessly integrates with commonly used cryogenic electron microscopy software such as RELION, Dynamo and IMOD.

Running into bugs or missing a feature? Help us improve the project by opening an issue.

Installation

We recommend installation using one of the following methods

Method Command
PyPi pip install pytme
Source pip install git+https://github.com/KosinskiLab/pyTME
Docker docker build -t pytme -f docker/Dockerfile_GPU .

You can find alternative installation methods in the documentation.

User Guide

Learn how to get started with

How to Cite

If pyTME contributed significantly to your research, please cite the corresponding publication on SoftwareX.

@article{Maurer:2024aa,
    author = {Maurer, Valentin J. and Siggel, Marc and Kosinski, Jan},
    journal = {SoftwareX},
    pages = {101636},
    title = {PyTME (Python Template Matching Engine): A fast, flexible, and multi-purpose template matching library for cryogenic electron microscopy data},
    volume = {25},
    year = {2024}}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytme-0.2.5.tar.gz (12.0 MB view details)

Uploaded Source

Built Distribution

pytme-0.2.5-cp311-cp311-macosx_14_0_arm64.whl (12.3 MB view details)

Uploaded CPython 3.11 macOS 14.0+ ARM64

File details

Details for the file pytme-0.2.5.tar.gz.

File metadata

  • Download URL: pytme-0.2.5.tar.gz
  • Upload date:
  • Size: 12.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for pytme-0.2.5.tar.gz
Algorithm Hash digest
SHA256 ca8d6290c1de47c731a2c18a84101efb74c178f3986d90ecf0c651efdc3447ad
MD5 d24e011825d112b9e1e24d55f8ff78d2
BLAKE2b-256 aa05ab435b237cbfa80c47809233eba4e81c0879a299b237400f4307bea3fbbf

See more details on using hashes here.

File details

Details for the file pytme-0.2.5-cp311-cp311-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for pytme-0.2.5-cp311-cp311-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 8b78cbec20a3c3bf03a3b498eb2b73f1720e106cc929e4dfab55e90e9dfb6234
MD5 23e070382f7c519747484a6c19208765
BLAKE2b-256 de903b115be3fa0728beeda1c7559546d7ce46fa0f56d54e91441012c67f15d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page