mrsimulator:docs v0.7.0rc2
  • previous
  • next
  • index
  • Show Source

Logo

Quick search

Enter search terms or a module, class or function name.

Table of Contents

Introduction

  • Installation
    • For the users
    • For developers and contributors
    • Troubleshooting
    • Package dependencies
  • Getting Started
  • Ethanol Example

User Documentation

  • Spin System
  • Spin System Distributions
  • Methods Library
  • Method (For advanced users)
  • Query Objects
  • Simulator
  • Signal Processing
  • mrsimulator I/O

Galleries

  • Simulation Gallery
  • Fitting (Least Squares) Gallery
  • Signal Processing Gallery

Theory

  • How does mrsimulator work?
  • Models

API and references

  • Simulation API
  • Signal-processing API
  • Models API
  • Fitting Utility API
  • C-API References

Project details

  • Changelog
  • Authors and Credits
  • License
  • Acknowledgment

InstallationΒΆ

Contents:

  • For the users
    • Strict Requirements
    • Installing mrsimulator
    • Test your build
  • For developers and contributors
    • Setting up a dedicated code editor
    • Make your own copy of mrsimulator on GitHub
    • Create a development environment
    • Make sure git is installed on your computer
    • Copy your fork of mrsimulator from GitHub to your computer
    • Understanding Remotes
    • Build the development version of mrsimulator
    • Note for the developers and contributors
  • Troubleshooting
    • Installing Python
    • Google Colab and Jupyter Notebooks
    • Virtual Environments
    • Common Python Syntax Errors
  • Package dependencies

Page Source   Back to Top

© Copyright 2019-2022, The Mrsimulator Developers.
Created using Sphinx 3.4.3.   Last built May 21, 2022.