Getting Started

Welcome to CDIutils! This section will help you get up and running quickly with Bragg Coherent X-ray Diffraction Imaging (BCDI) data analysis.

• Quickstart: 5-Minute BCDI Analysis
  • Prerequisites
  • Minimal Working Example
  • Understanding the Output
  • Next Steps
  • Common Issues
• BCDI Concepts and Conventions
  • BCDI Workflow Overview
  • Coordinate Systems
  • Reciprocal Space Concepts
  • Phase and Displacement
  • Sample Orientation
  • Detector Geometry
  • Support and Autocorrelation
  • Further Reading
• First Complete Analysis

What is BCDI?

Bragg Coherent Diffraction Imaging is a lensless imaging technique that provides 3D maps of lattice displacement and strain in crystalline nanostructures with nanometre spatial resolution.

CDIutils provides:

• Automated workflows via BcdiPipeline

• Beamline-specific data loaders (ID01, P10, SIXS, NanoMAX, etc.)

• Coordinate system handling for multiple experimental geometries

• Phase retrieval integration with PyNX

• Post-processing tools for strain, displacement analysis

• Interactive visualisation for 3D data exploration

Quick Links

New users:

Start with Quickstart: 5-Minute BCDI Analysis for a 5-minute example

Example notebooks:

See Examples for interactive Jupyter examples

API reference:

Browse API Reference for detailed class documentation

BCDI concepts:

Read BCDI Concepts and Conventions for coordinate systems and reciprocal space

Next Steps

1. Installation - Install CDIutils and dependencies

2. Quickstart: 5-Minute BCDI Analysis - Run your first analysis in 5 minutes

3. BCDI Concepts and Conventions - Understand BCDI workflow and conventions

4. First Complete Analysis - Complete analysis from raw data to strain maps