Quicklinks

• Starting from a clean slate?

  Check out the installation instructions
• You want to understand the inner principles of ptypy without having to browse the source code?

  Have a look at the tutorials about its special classes.
• Only interested in PtyPy’s data file structure and management?

  Indulge yourself here for the structure and here for the concepts.

Ptypy documentation contents

• Getting started with Ptypy
  • Installation
    • General installation instructions
  • Quickstart with a minimal script
    • Preparing the parameter tree
    • Running ptypy
  • Utilies/Binaries for convenience
    • Plotting from a reconstruction/dump file (*.ptyr)
    • Inspecting a hdf5 compatible file
    • Create a new template for a reconstruction script
    • Run a plotclient in a separate process
  • More script templates
    • All-in-one
    • Creating a .ptyd data-file
    • Loading a data file to run a reconstruction
• Concepts and Classes
  • Tutorial: Data access - Storage, View, Container
    • A single Storage in one Container
    • Adding Views as a way to access data
  • Tutorial: Modeling the experiment - Pod, Geometry
    • Set experimental setup geometry and create propagator
    • Create probing illumination
    • Create scan pattern and object
    • Creating additional Views and the PODs
    • Storing the simulation
  • Tutorial: A reconstruction engine from scratch
    • Preparing a managing Ptycho instance
    • A basic Difference-Map implementation
• Data management
  • The PtyScan class
  • Usage scenarios
  • Ptyd file format
  • Tutorial : Subclassing PtyScan
    • Writing a subclass
    • Loading the data
    • Listing the new subclass
• Parameter tree structure
  • io
    • io.interaction
  • scandata
    • scandata.PtyScan
    • scandata.PtydScan
    • scandata.MoonFlowerScan
    • scandata.QuickScan
    • scandata.SimScan
  • scan
    • scan.ScanModel
    • scan.BlockScanModel
    • scan.Vanilla
    • scan.BlockVanilla
    • scan.Full
    • scan.BlockFull
    • scan.OPRModel
    • scan.BlockOPRModel
    • scan.GradFull
    • scan.BlockGradFull
    • scan.Bragg3dModel
  • engine
    • engine.DM
    • engine.RAAR
    • engine.EPIE
    • engine.SDR
    • engine.ML
    • engine.DM_3dBragg
  • ptycho
    • ptycho.io
    • ptycho.scans
    • ptycho.engines
• ptypy package
  • Subpackages
    • ptypy.core package
    • ptypy.engines package
    • ptypy.experiment package
    • ptypy.io package
    • ptypy.resources package
    • ptypy.simulations package
    • ptypy.utils package
    • ptypy.debug package
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page