mrfmsim: A modular, extendable, and readable simulation package for magnetic resonance force microscopy experiments

TL;DR

mrfmsim is an open-source Python package that simplifies the design, simulation, and analysis of MRFM experiments, enhancing reproducibility and development speed in this complex, sensitive research area.

Contribution

The paper introduces mrfmsim, a modular, extendable, and readable simulation package that addresses challenges in MRFM experiment simulation and customization.

Findings

Supports post-definition customization without rewriting models

Employs a plugin system for extending functionality

Improves reproducibility and accelerates development

Abstract

We present mrfmsim, an open-source Python package that facilitates the design, simulation, and analysis of magnetic resonance force microscopy (MRFM) experiments. MRFM is a scanning-probe technique that detects magnetic resonance from nanoscale ensembles of nuclear or electron spins with a force sensor. Because MRFM experiments are complex and operate at sensitivity limits, numerical simulation is essential for designing experiments and estimating per-spin sensitivity and imaging resolution from measured signals. In this paper, we highlight the challenges of developing MRFM simulations and show that software designed to simulate specific experiments only in a rapidly evolving experimental field can yield erroneous results. The mrfmsim package addresses these challenges by supporting post-definition customization without rewriting the internal model and by employing a plugin system for extending functionality. We show that the package's modular, extendable, and readable architecture improves reproducibility and accelerates development.