crystalmapping Documentation

Welcome to the document of the crystalmapping. The package is a toolbox for the data collection, processing, analysis and visualization in the crystal mapping. The crystal mapping is a technique to reveal the spatial or oriental distribution of single crystals using a series of x-ray diffraction data. There are an old algorithm and a new algorithm to do this. The package includes both of them. It is recommended to use the new one.

• Installation
  • Installation from conda
  • Installation from source
• Run experiments at NSLS-II
  • Simulated motors and detectors
  • Fly scan
  • Grid scan
• Use the old peak tracking algorithm in streaming data processing
  • Take a look at the raw data
  • Use callbacks to process the event stream
  • Use servers to process the real time event stream
  • Pipe the data into the database
• Use new algorithm to run the batch processing
  • Create the calculator
  • Load the experiment Data
  • Process the data
  • Visualize the data
  • Save the data
  • Load the dataset and visualize it
• API Documents
  • crystalmapping.plans
  • crystalmapping.servers
  • crystalmapping.crystalmapper
  • crystalmapping.callbacks
  • crystalmapping.peakindexer
• Minimum Version of Python and NumPy