Skip to main content

A python package for working with crystal orientations in transmission electron microscopy

Project description

# pycotem

pycotem is a python package for working with crystal orientations in transmission electron microscopy. It provides 6 GUI tools to:

  • determine orientation from diffraction patterns: `diffraction`

  • determine orientation from Kikuchi patterns: `kikuchi`

  • work with stereographic projections: `stereoproj`

  • determine interface normal and direction from images: `interface`

  • determine orientation relationship and misorientation between two crystals: `misorientation`

  • display crystal projection on a plane and draw dichromatic patterns: `crystal`

## Getting Started

### Prerequisites

pycotem relies on `python3` with `numpy`, `pillow`, `matplotlib` and `pyqt5` (for GUI) packages.

### Installing and running

pycotem can be installed with pip: `pip3 install pycotem` Run `python3 -m pycotem.xxxx` for the different tools: `stereoproj`, `diffraction`, `kikuchi`,```misorientation```,```interface``` and `crystal`.

### Examples

Image files and setting parameters are provided in the `test` directory in the github repository for testing `diffraction`, `interface` and `kikuchi`.

## Documentation

Available [here](https://mompiou.github.io/pycotem)

## Contributing

Contributions, bug issues, requests and comments can be adressed directly or through pull-request on github.

## Authors

[F. Mompiou](https://github.com/mompiou), with idea from [RX Xie](https://github.com/XIEruixun) (Tsinghua Univ), J. Du (Tsinghua Univ.) and the contribution of G. Perret (Univ. Toulouse).

## License

This project is licensed under the GPL-3.0 License.

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

pycotem-2.0.2.tar.gz (882.6 kB view hashes)

Uploaded Source

Built Distribution

pycotem-2.0.2-py3-none-any.whl (889.7 kB view hashes)

Uploaded Python 3

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