# 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.
Raw data
{
"_id": null,
"home_page": "https://mompiou.github.io/pycotem/",
"name": "pycotem",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "scientific, crystallography, electron microscopy",
"author": "f. mompiou",
"author_email": "frederic.mompiou@cemes.fr",
"download_url": "https://files.pythonhosted.org/packages/25/48/71f6aa773d2960b6ed4d71e809f2362c63714c0ecb6cbf087e6c979cbfe9/pycotem-2.12.0.tar.gz",
"platform": null,
"description": "# pycotem\n\n\n\npycotem is a python package for working with crystal orientations in transmission electron microscopy. It provides 6 GUI tools to:\n\n- determine orientation from diffraction patterns: ```diffraction```\n\n- determine orientation from Kikuchi patterns: ```kikuchi```\n\n- work with stereographic projections: ```stereoproj```\n\n- determine interface normal and direction from images: ```interface```\n\n- determine orientation relationship and misorientation between two crystals: ```misorientation```\n\n- display crystal projection on a plane and draw dichromatic patterns: ```crystal```\n\n## Getting Started\n\n### Prerequisites\n\npycotem relies on ```python3``` with ```numpy```, ```pillow```, ```matplotlib``` and ```pyqt5``` (for GUI) packages.\n\n### Installing and running\n\npycotem can be installed with pip: ```pip3 install pycotem```\nRun ```python3 -m pycotem.xxxx``` for the different tools: ```stereoproj```, ```diffraction```, ```kikuchi```,```misorientation```,```interface``` and ```crystal```.\n\n### Examples\n\nImage files and setting parameters are provided in the ```test``` directory in the github repository for testing ```diffraction```, ```interface``` and ```kikuchi```.\n\n## Documentation\n\nAvailable [here](https://mompiou.github.io/pycotem)\n\n\n## Contributing\n\nContributions, bug issues, requests and comments can be adressed directly or through pull-request on github.\n\n## Authors\n\n[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).\n\n\n## License\n\nThis project is licensed under the GPL-3.0 License.\n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A python package for working with crystal orientations in transmission electron microscopy",
"version": "2.12.0",
"project_urls": {
"Download": "https://github.com/mompiou/pycotem",
"Homepage": "https://mompiou.github.io/pycotem/"
},
"split_keywords": [
"scientific",
" crystallography",
" electron microscopy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd99b80c867df937e17757837b6ac4c006a4ff65be539e67762c09b980812a57",
"md5": "60b8a0c9d03b091353aa85997d34217e",
"sha256": "d2289e0dc7ac0a006014d3da9ca0e50d68916daa5d408251174f18a5cda7c4d7"
},
"downloads": -1,
"filename": "pycotem-2.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60b8a0c9d03b091353aa85997d34217e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 937821,
"upload_time": "2024-03-25T16:19:42",
"upload_time_iso_8601": "2024-03-25T16:19:42.155458Z",
"url": "https://files.pythonhosted.org/packages/fd/99/b80c867df937e17757837b6ac4c006a4ff65be539e67762c09b980812a57/pycotem-2.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "254871f6aa773d2960b6ed4d71e809f2362c63714c0ecb6cbf087e6c979cbfe9",
"md5": "057a8d0858b2fff61d358ba7bd99cf8d",
"sha256": "38bdd4c908b307a94a691d2892ddce5494382ee0c991774b2317307a471275a7"
},
"downloads": -1,
"filename": "pycotem-2.12.0.tar.gz",
"has_sig": false,
"md5_digest": "057a8d0858b2fff61d358ba7bd99cf8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3484448,
"upload_time": "2024-03-25T16:19:45",
"upload_time_iso_8601": "2024-03-25T16:19:45.132929Z",
"url": "https://files.pythonhosted.org/packages/25/48/71f6aa773d2960b6ed4d71e809f2362c63714c0ecb6cbf087e6c979cbfe9/pycotem-2.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 16:19:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mompiou",
"github_project": "pycotem",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pycotem"
}
JSON
