Skip to main content

Bonsu - The Interactive Phase Retrieval Suite

Project description

Build Status License: GPL v3 Python Versions PyPI PyPI - Wheel

Bonsu - The Interactive Phase Retrieval Suite

Introduction

Bonsu is a collection of tools and algorithms for the reconstruction of phase information from diffraction intensity measurements. Its primary focus is Bragg Coherent Diffraction Imaging (BCDI) data visualisation, reconstruction and analysis.

Citation

If your use of this software results in a scientific publication, please cite the following article:

Newton M. C., Nishino Y. and Robinson I. K., J., Appl. Cryst. (2012). 45, 840-843.

Installation

Bonsu requires:

  • Python >= 3.7
  • wxPython >= 4.2.0
  • NumPy (FFTW aware) >= 1.4.1
  • VTK (with python bindings) >= 8.0.0
  • h5py
  • Pillow
  • Cython >= 3.0.0
  • FFTW with threading >= 3.0

Installation via pip:

$ pip install bonsu

To run:

$ bonsu 

Reporting Bugs

Please send any bugs, problems, and proposals to: Bonsu.Devel@gmail.com or visit: http://github.com/bonsudev/bonsu

Documentation

Online documentation is available here and includes installation instructions. A PDF version of the documentation is available here. Documentation is also available in the application.

Version History

Please see the change log.

Licence

GNU GPLv3 Copyright 2011 - 2024 - Marcus C. Newton Registration number 284653218

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page