Metadata-Version: 2.1
Name: diffsims
Version: 0.2.2
Summary: Diffraction Simulations in Python.
Home-page: https://github.com/pyxem/diffsims
Author: Duncan Johnstone, Phillip Crout
Author-email: pyxem.team@gmail.com
License: GPLv3
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.6
Requires-Dist: scipy (>=0.15)
Requires-Dist: numpy (>=1.10)
Requires-Dist: matplotlib (>=3.1.1)
Requires-Dist: tqdm (>=0.4.9)
Requires-Dist: transforms3d
Requires-Dist: diffpy.structure (>=3.0.0)

|Travis|_ |AppVeyor|_ |Coveralls|_ |pypi_version|_  |doi|_

.. |Travis| image:: https://travis-ci.org/pyxem/diffsims.svg?branch=master
.. _Travis: https://travis-ci.org/pyxem/diffsims

.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/pyxem/diffsims?svg=true&branch=master
.. _AppVeyor: https://ci.appveyor.com/project/dnjohnstone/diffsims/branch/master

.. |Coveralls| image:: https://coveralls.io/repos/github/pyxem/diffsims/badge.svg?branch=master
.. _Coveralls: https://coveralls.io/github/pyxem/diffsims?branch=master

.. |pypi_version| image:: http://img.shields.io/pypi/v/diffsims.svg?style=flat
.. _pypi_version: https://pypi.python.org/pypi/diffsims

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3337900.svg
.. _doi: https://doi.org/10.5281/zenodo.3337900


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

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

diffsims is released under the GPL v3 license.


Installation
------------

diffsims requires python 3 and conda - we suggest using the python 3 version of `Miniconda <https://conda.io/miniconda.html>`__ and creating a new environment for diffsims using the following commands in the anaconda prompt:::

      $ conda create -n diffsims
      $ conda activate diffsims

The recommended way to install diffsims is then from conda-forge using:::

      $ conda install -c conda-forge diffsims

Note that diffsims is also available via pip:::

      $ pip install diffsims


