Skip to content
/ diffsims Public

An open-source Python library providing utilities for simulating diffraction

License

Notifications You must be signed in to change notification settings

pyxem/diffsims

Repository files navigation

diffsims is an open-source Python library for simulating diffraction.

The package is released under the GPL v3 license.

Deployment pypi_version conda
Build status build_status docs python
Metrics Coveralls
Activity pypi_downloads conda_downloads
Citation doi
License GPLv3
Community GH-issues
Formatter black

Documentation

Refer to the documentation for detailed installation instructions, a user guide, a technical (API) reference, and the changelog.

Installation

diffsims can be installed with pip:

pip install diffsims

or conda:

conda install diffsims -c conda-forge

The source code is hosted in GitHub, and can also be downloaded from PyPI and Anaconda.

Further details are available in the installation guide.

Citing diffsims

If simulations performed using diffsims form a part of published work please cite the DOI at the top of this page.