MrfmSim#
MrfmSim is a Python framework for simulating magnetic resonance force microscopy (MRFM) experiments. The package is based on the mmodel framework, which provides modular modeling capabilities for the experiments. The framework offers additional functionalities for interacting and modifying the experiment models, for example, scripting using YAML files, creating optimized loops, printing out intermediate results, and grouping experiments using experiment collections. The package also provides various features through the plugin system, including a command line interface, unit system, and three-dimensional plotting capabilities. The detailed API and the available plugins are documented.
Quickstart#
Installation#
Graphviz installation#
To view the graph, Graphviz needs to be installed: Graphviz Installation For Windows installation, please choose “add Graphviz to the system PATH for all users/current users” during the setup.
For macOS systems, sometimes brew install results in an unexpected installation path, it is recommended to install with conda:
conda install -c conda-forge pygraphviz
mrfmsim installation#
To install the package, run:
pip install .
Tests#
To run the tests locally:
python -m pytest
To test in different environments:
tox
License#
MrfmSim is distributed with the 3-clause BSD license.:
Copyright (C) 2023-2024
Peter Sun <hs859@cornell.edu>
John Marohn <jam99@cornell.edu>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the NetworkX Developers nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.