Metadata-Version: 2.1
Name: simos
Version: 0.2.1
Summary: Spin simulations in Python (NMR, EPR/ESR as well as ODMR).
Home-page: https://simos.kherb.io
Author: Konstantin Herb
Author-email: science@rashbw.de
License: all rights reserved
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: GPU
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.25.0
Requires-Dist: scipy>=1.12.0
Provides-Extra: recommended
Requires-Dist: qutip>=5.0.0; extra == "recommended"
Requires-Dist: sympy>=1.11; extra == "recommended"
Requires-Dist: matplotlib; extra == "recommended"
Requires-Dist: IPython; extra == "recommended"
Provides-Extra: full
Requires-Dist: qutip; extra == "full"
Requires-Dist: sympy; extra == "full"
Requires-Dist: matplotlib; extra == "full"
Requires-Dist: numba>=0.58.0; extra == "full"
Requires-Dist: IPython; extra == "full"
Requires-Dist: tkinter; extra == "full"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: simos[recommended]; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: simos[full]; extra == "test"


# SimOS
SimOS (**SIM**ulation of **O**ptically-adressable **S**pins) is a versatile library for the simulation of open quantum systems consisting of spins, electronic levels and combinations thereoff. Originally developed for optically detected magnetic resonance (ODMR) experiments, SimOS is also capable of performing general nuclear magnetic resonance (NMR) and electron paramagnetic resonance (EPR/ESR) simulations. Its main focus is to simulate optically adressable spins or purely optical systems. 

SimOS provides an interface for constructing operators and super-operators for complex systems of spins and electronic levels, facilitating simulations of their dynamics across various theoretical levels. The library integrates seamlessly with popular Python libraries such as numpy, scipy, qutip, and sympy, which can be chosen as backends. 

Our primary focus is on the quantum master equation (QME) in Lindblad form, for which we offer various engines for computationally efficient time propagation. Additionally, SimOS supports the simulation of spatial dynamics, including rotational diffusion, linear flow, and magic angle spinning, through our Fokker-Planck framework.

SimOS aims to provide a pen-and-paper style of simulation, minimizing high-level functions to keep the syntax clean and mathematically driven. While SimOS can perform a wide range of simulations, it was designed to be a Python-based alternative to other established simulation tools, offering similar capabilities in a more accessible and flexible environment.
