Skip to content

API Reference

This section provides auto-generated documentation for the public API of synth-afm.

The library is organised into three core modules:

  • synth_afm.simulator — High-level AFMSimulator class for generating height maps and movies.
  • synth_afm.kernels — Low-level differentiable JAX kernels for height mapping and tip dilation.
  • synth_afm.io — Structure file I/O and atomic radius assignment.