Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyxem/diffsims

An open-source Python library providing utilities for simulating diffraction
https://github.com/pyxem/diffsims

diffraction electron-diffraction physics physics-simulation python

Last synced: 3 days ago
JSON representation

An open-source Python library providing utilities for simulating diffraction

Host: GitHub
URL: https://github.com/pyxem/diffsims
Owner: pyxem
License: gpl-3.0
Created: 2019-07-15T15:48:40.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-10-11T20:24:47.000Z (2 months ago)
Last Synced: 2024-12-13T14:08:05.666Z (10 days ago)
Topics: diffraction, electron-diffraction, physics, physics-simulation, python
Language: Python
Homepage: https://diffsims.readthedocs.io
Size: 6.39 MB
Stars: 46
Watchers: 7
Forks: 26
Open Issues: 20
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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

The package is released under the GPL v3 license.

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

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/diffsims.svg?logo=conda-forge&logoColor=white
:target: https://anaconda.org/conda-forge/diffsims

.. |build_status| image:: https://github.com/pyxem/diffsims/workflows/build/badge.svg
:target: https://github.com/pyxem/diffsims/actions/workflows/build.yml

.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg
:target: https://www.python.org/downloads/

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

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/diffsims.svg?label=PyPI%20downloads
:target: https://pypi.org/project/diffsims/

.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/diffsims.svg?label=Conda%20downloads
:target: https://anaconda.org/conda-forge/diffsims

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

.. |GPLv3| image:: https://img.shields.io/github/license/pyxem/diffsims
:target: https://opensource.org/license/GPL-3.0

.. |GH-issues| image:: https://img.shields.io/badge/GitHub-Issues-green?logo=github
:target: https://github.com/pyxem/diffsims/issues

.. |docs| image:: https://readthedocs.org/projects/diffsims/badge/?version=latest
:target: https://diffsims.readthedocs.io/en/latest

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/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.