User Guide

Here we provide all the information needed to use the atomSmltr package

Getting started

• Installation 🚀
• Testing atomsmltr ✨

Documentation

• Overview
• Spatial coordinates conventions
• Laser propagation conventions
• Polarization conventions

Examples

• Atoms & Transitions
  • Work with existing atoms
  • Atoms properties
  • Atoms methods
  • Transitions properties & methods
  • Define custom atoms and transitions
• Lasers
  • Create a laser object
  • Some useful methods and properties
  • Plotting
• Magnetic fields
  • magnetic field offset
  • magnetic field gradient
  • magnetic field quadrupole
• Forces
  • Include a constant force (gravity)
• Zones
  • Introduction to zones
  • Zone collections
  • A few examples of zones collections
• Configuration
  • Introduction to configurations
  • Manage objects in a collection
  • Setting up atom-light couplings
• Simulations
  • Minimal example of a simulation
  • Parallel computation
  • Use zones to stop the simulation
• Magpylib integration
• Environment objects modifiers
  • with scalar objects
  • with vector objects
• Polarization maps
  • Simple example : constant offset magnetic field
  • Complex example : polarization map
• MOT
  • global config
  • 1D test
  • 3D test
• Physical benchmarks: one-dimensional MOT
  • Formulaes and orders of magnitude
  • Definitions
  • Simulations
• Physical benchmarks: Doppler temperature
  • Formulaes and orders of magnitude
  • Test: laser cooling of ytterbium
• Physical benchmarks: radiation pressure
  • Formulaes and orders of magnitude
  • Test #1 : initial acceleration of an atom at rest
  • Test #2 : Doppler friction
• Thermal beam generation
  • Context
  • Simulation