Metadata-Version: 2.2
Name: prismatique
Version: 0.0.1
Summary: A wrapper to the Python library `pyprismatic`, which is a library for simulating CBED, STEM, and HRTEM experiments using Multislice algorithms.
Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
Project-URL: Homepage, https://mrfitzpa.github.io/prismatique
Project-URL: Repository, https://github.com/mrfitzpa/prismatique
Keywords: hyperspy,multislice,CBED,STEM,HRTEM,GPU,prismatic,pyprismatic,microscopy,electron beam,electron probe
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: embeam
Requires-Dist: h5pywrappers
Provides-Extra: tests
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: examples
Requires-Dist: jupyter; extra == "examples"
Requires-Dist: ipympl; extra == "examples"
Provides-Extra: docs
Requires-Dist: sphinx<7; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: docutils; extra == "docs"
Provides-Extra: all
Requires-Dist: prismatique[docs,examples,tests]; extra == "all"

# Prismatique

[![Test library](https://github.com/mrfitzpa/prismatique/actions/workflows/test_library.yml/badge.svg)](https://github.com/mrfitzpa/prismatique/actions/workflows/test_library.yml)
[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mrfitzpa/75a9dc87bd52856433f20af68b721f9a/raw/prismatique_coverage_badge.json)](https://github.com/mrfitzpa/prismatique/actions/workflows/measure_code_coverage.yml)
[![Documentation](https://img.shields.io/badge/docs-read-brightgreen)](https://mrfitzpa.github.io/prismatique)
[![PyPi Version](https://img.shields.io/pypi/v/prismatique.svg)](https://pypi.org/project/prismatique)
[![Conda-Forge Version](https://img.shields.io/conda/vn/conda-forge/prismatique.svg)](https://anaconda.org/conda-forge/prismatique)
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

`prismatique` is a Python library that functions essentially as a wrapper to the
Python library `pyprismatic`, which itself is a thin wrapper to `prismatic`, a
CUDA/C++ package for fast image simulations in scanning transmission electron
microscopy and high-resolution transmission electron microscopy. You can find
more information about `pyprismatic` and `prismatic`
[here](https://prism-em.com).

Visit the `prismatique` [website](https://mrfitzpa.github.io/prismatique) for a
web version of the installation instructions, the reference guide, and the
examples archive.

<!--
For those reading raw .rst files, see file `docs/INSTALL.rst` for instructions
on installing the `prismatique` library.
-->
