https://github.com/diamondlightsource/fast_rsm

A fast reciprocal space mapper used at Diamond Light Source
https://github.com/diamondlightsource/fast_rsm

Last synced: 9 months ago
JSON representation

A fast reciprocal space mapper used at Diamond Light Source

• Host: GitHub
• URL: https://github.com/diamondlightsource/fast_rsm
• Owner: DiamondLightSource
• Created: 2022-03-02T09:47:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T13:28:02.000Z (over 2 years ago)
• Last Synced: 2024-04-10T14:57:12.624Z (over 2 years ago)
• Language: Python
• Homepage:
• Size: 8.38 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Total alerts](https://img.shields.io/lgtm/alerts/g/RBrearton/fast_rsm.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RBrearton/fast_rsm/alerts/)

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/RBrearton/fast_rsm.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RBrearton/fast_rsm/context:python)

[![codecov](https://codecov.io/gh/RBrearton/fast_rsm/branch/master/graph/badge.svg?token=FGIV0MVHS8)](https://codecov.io/gh/RBrearton/fast_rsm)

[![Actions Status](https://github.com/RBrearton/fast_rsm/workflows/pytest/badge.svg)](https://github.com/pytest/fast_rsm/actions)

[![Documentation Status](https://readthedocs.org/projects/local-stats/badge/?version=latest)](https://local-stats.readthedocs.io/en/latest/?badge=latest)

A fast reciprocal space mapper.

This module depends on two other modules:

https://github.com/DiamondLightSource/diffraction_utils

is used for the parsing of awkward data formats and for the generation of many

of the scipy.spatial.transform.Rotation objects that are used in the

calculations. The idea is that https://github.com/DiamondLightSource/diffraction_utils is

a general purpose tool that can be used in many contexts besides purely

reciprocal space mapping, although it originated as a spin-out of this project.

https://github.com/DiamondLightSource/mapper_c_utils contains the binning algorithm used

by default, although several more are included in the fast_rsm.binning module. I

found that the simple binning algorithm contained in custom-bin for 3D datasets

is significantly faster than fast-histogram's histogramdd, which is faster than

my custom numpy routine, which is faster than numpy's histogramdd. It contains

some other useful routines, but I find it nice to keep the high performance C

stuff in a separate repository. This fast_rsm repo should contain exclusively

nice, easy to read and organised python code.