Electron Microscopy Beam (EMBeam)

embeam is a Python library for for modelling beams and lenses in electron microscopy.

The source code can be found in the embeam GitHub repository.

Instructions for installing and uninstalling embeam

For instructions on installing the embeam library, see the Instructions for installing and uninstalling embeam page.

Learning how to use embeam

For those new to the embeam library, it is recommended that they take a look at the Examples page, which contain code examples that show how one can use the embeam library. While going through the examples, readers can consult the embeam reference guide to understand what each line of code is doing.

Contents

• Home
• 1. Instructions for installing and uninstalling embeam
  • 1.1. Installing embeam
    • 1.1.1. Installing embeam using pip
    • 1.1.2. Installing embeam using conda
  • 1.2. Uninstalling embeam
• 2. Reference
  • 2.1. embeam.wavelength
    • wavelength()
  • 2.2. embeam.coherent
    • 2.2.1. embeam.coherent.Aberration
      • Aberration
        • Aberration.core_attrs
        • Aberration.de_pre_serialization_funcs
        • Aberration.de_pre_serialize()
        • Aberration.dump()
        • Aberration.dumps()
        • Aberration.get_core_attrs()
        • Aberration.get_de_pre_serialization_funcs()
        • Aberration.get_pre_serialization_funcs()
        • Aberration.get_validation_and_conversion_funcs()
        • Aberration.is_azimuthally_symmetric
        • Aberration.load()
        • Aberration.loads()
        • Aberration.pre_serialization_funcs
        • Aberration.pre_serialize()
        • Aberration.update()
        • Aberration.validation_and_conversion_funcs
    • 2.2.2. embeam.coherent.PhaseDeviation
      • PhaseDeviation
        • PhaseDeviation.core_attrs
        • PhaseDeviation.de_pre_serialization_funcs
        • PhaseDeviation.de_pre_serialize()
        • PhaseDeviation.dump()
        • PhaseDeviation.dumps()
        • PhaseDeviation.eval()
        • PhaseDeviation.get_core_attrs()
        • PhaseDeviation.get_de_pre_serialization_funcs()
        • PhaseDeviation.get_pre_serialization_funcs()
        • PhaseDeviation.get_validation_and_conversion_funcs()
        • PhaseDeviation.is_azimuthally_symmetric
        • PhaseDeviation.load()
        • PhaseDeviation.loads()
        • PhaseDeviation.pre_serialization_funcs
        • PhaseDeviation.pre_serialize()
        • PhaseDeviation.update()
        • PhaseDeviation.validation_and_conversion_funcs
  • 2.3. embeam.constants
    • 2.3.1. embeam.constants.c
      • c()
    • 2.3.2. embeam.constants.e
      • e()
    • 2.3.3. embeam.constants.h
      • h()
    • 2.3.4. embeam.constants.m_e
      • m_e()
  • 2.4. embeam.gun
    • 2.4.1. embeam.gun.ModelParams
      • ModelParams
        • ModelParams.core_attrs
        • ModelParams.de_pre_serialization_funcs
        • ModelParams.de_pre_serialize()
        • ModelParams.dump()
        • ModelParams.dumps()
        • ModelParams.get_core_attrs()
        • ModelParams.get_de_pre_serialization_funcs()
        • ModelParams.get_pre_serialization_funcs()
        • ModelParams.get_validation_and_conversion_funcs()
        • ModelParams.load()
        • ModelParams.loads()
        • ModelParams.pre_serialization_funcs
        • ModelParams.pre_serialize()
        • ModelParams.update()
        • ModelParams.validation_and_conversion_funcs
  • 2.5. embeam.lens
    • 2.5.1. embeam.lens.ModelParams
      • ModelParams
        • ModelParams.core_attrs
        • ModelParams.de_pre_serialization_funcs
        • ModelParams.de_pre_serialize()
        • ModelParams.dump()
        • ModelParams.dumps()
        • ModelParams.get_core_attrs()
        • ModelParams.get_de_pre_serialization_funcs()
        • ModelParams.get_pre_serialization_funcs()
        • ModelParams.get_validation_and_conversion_funcs()
        • ModelParams.is_azimuthally_symmetric
        • ModelParams.load()
        • ModelParams.loads()
        • ModelParams.pre_serialization_funcs
        • ModelParams.pre_serialize()
        • ModelParams.update()
        • ModelParams.validation_and_conversion_funcs
  • 2.6. embeam.stem
    • 2.6.1. embeam.stem.probe
      • 2.6.1.1. embeam.stem.probe.ModelParams
        • ModelParams
          • ModelParams.core_attrs
          • ModelParams.de_pre_serialization_funcs
          • ModelParams.de_pre_serialize()
          • ModelParams.dump()
          • ModelParams.dumps()
          • ModelParams.get_core_attrs()
          • ModelParams.get_de_pre_serialization_funcs()
          • ModelParams.get_pre_serialization_funcs()
          • ModelParams.get_validation_and_conversion_funcs()
          • ModelParams.is_azimuthally_symmetric
          • ModelParams.is_coherent
          • ModelParams.load()
          • ModelParams.loads()
          • ModelParams.pre_serialization_funcs
          • ModelParams.pre_serialize()
          • ModelParams.update()
          • ModelParams.validation_and_conversion_funcs
      • 2.6.1.2. embeam.stem.probe.discretized
        • 2.6.1.2.1. embeam.stem.probe.discretized.kspace
          • 2.6.1.2.1.1. embeam.stem.probe.discretized.kspace.Intensity
          • 2.6.1.2.1.2. embeam.stem.probe.discretized.kspace.Wavefunction
        • 2.6.1.2.2. embeam.stem.probe.discretized.periodic
          • 2.6.1.2.2.1. embeam.stem.probe.discretized.periodic.rspace
        • 2.6.1.2.3. embeam.stem.probe.discretized.symmetric
          • 2.6.1.2.3.1. embeam.stem.probe.discretized.symmetric.rspace
      • 2.6.1.3. embeam.stem.probe.kspace
        • 2.6.1.3.1. embeam.stem.probe.kspace.Intensity
          • Intensity
        • 2.6.1.3.2. embeam.stem.probe.kspace.Wavefunction
          • Wavefunction
      • 2.6.1.4. embeam.stem.probe.resolution
        • 2.6.1.4.1. embeam.stem.probe.resolution.information
          • information()
        • 2.6.1.4.2. embeam.stem.probe.resolution.rise_distance
          • rise_distance()
      • 2.6.1.5. embeam.stem.probe.symmetric
        • 2.6.1.5.1. embeam.stem.probe.symmetric.rspace
          • 2.6.1.5.1.1. embeam.stem.probe.symmetric.rspace.Intensity
          • 2.6.1.5.1.2. embeam.stem.probe.symmetric.rspace.Wavefunction
  • 2.7. embeam.version
• 3. Examples
• 4. License

Indices and tables

• Index

• Module Index

• Search Page