Welcome to flatspin’s documentation!

Contents:

• Installation
  • Python version
  • Dependencies
  • Optional dependencies
• Quickstart
  • Running simulations
  • Viewing results
  • Datasets
  • Filtering datasets
  • Running from Python
  • Reading datasets from Python
  • More reading
• Model
  • Magnets as dipoles
  • Magnetic Fields and Temperature
  • Magnetic dipole-dipole interactions
  • External field
  • Thermal field
  • Switching
  • Imperfections and disorder
  • Dynamics
  • Geometries
  • Parameter and variable listing
  • Choosing parameters
• Running
  • Running from the command line
• Datasets
• Extending flatspin

Reference

• API Reference
  • flatspin

Indices and tables

• Index

• Module Index

• Search Page