Code Monkey home page Code Monkey logo

diffsim's Introduction

License: GPL v3 Python Versions PyPI PyPI - Wheel

DiffSim

Introduction

DiffSim provides an atomistic approach to efficiently simulate Bragg coherent x-ray diffraction imaging (BCDI) diffraction patterns by factorising and eliminating certain redundancies in the conventional approach. The method used is able to reduce the computation time by several orders of magnitude without compromising the recovered phase information and therefore enables feasible atomistic simulations on nanoscale crystals with arbitrary lattice distortions.

Please cite the following article when using Diffsim in published work:

Ahmed Mokhtar, David Serban and Marcus Newton, Simulation of Bragg coherent diffraction imaging, J. Phys. Commun. Volume 6, 055003 (2022)

Installation

DiffSim requires:

  • Python >= 3.7
  • Numba >= 0.58.1
  • NumPy >= 1.25.0
  • scipy
  • mpi4py

Installation via pip:

$ pip install diffsim

Reporting Bugs

Please send any bugs, problems, and proposals to: [email protected] or visit: http://github.com/bonsudev/diffsim

Library Usage and Examples

Example scripts are available in the examples folder.

Version History

Version 1.2 ๐Ÿ—“ ๏ธ(02/11/2023)

๐Ÿ”ง Minor bug fixes.

Version 1.1 ๐Ÿ—“ ๏ธ(29/10/2023)

โœจ Refactored code for speed improvements.
โœจ Added attenuation and refraction corrections.
๐Ÿ”ง Minor bug fixes.

Version 1.0 ๐Ÿ—“ ๏ธ(14/09/2022)

โœจ First major release. 

Licence

GNU GPLv3

diffsim's People

Contributors

bonsudev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.