From 863a3cb997675a2e76d6873612daa1966354788e Mon Sep 17 00:00:00 2001 From: Stefano Scali Date: Thu, 5 Oct 2023 11:50:20 +0100 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6d04bd0..11b0904 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,15 @@ **(It is pronounced "spee-dee" 😊)** -Spin-Dynamics Julia package. The code is a generalization of the results obtained in the paper "Quantum Brownian motion for magnets" to account for arbitrary dimensional system-bath coupling. The system considered is a quantized three-dimensional spin + environment Hamiltonian. The code solves a set of differential equations for the spin vector where the damping accounts for memory, arbitrary noise and arbitrary statistics. +SpiDy.jl is a Julia package that solves the non-Markovian stochastic dynamics of interacting classical spin vectors and harmonic oscillator networks in contact with a dissipative environment. The methods implemented allow the user to include arbitrary memory effects and colored quantum noise spectra. In this way, SpiDy.jl provides key tools for the simulation of classical and quantum open systems including non-Markovian effects and arbitrarily strong coupling to the environment. Among the wide range of applications, some examples range from atomistic spin dynamics to ultrafast magnetism and the study of anisotropic materials. We provide the user with Julia notebooks to guide them through the various mathematical methods and help them quickly set up complex simulations. -The classical simulations in anisotropic coupling found in the pre-print "Quantum-classical correspondence in spin-boson equilibrium states at arbitrary coupling" have been generated using a very-early-version of this code. +## Reference paper +This is the reference paper for a quick overview and start with the code. You might also want to cite it in case it is useful! + +arXiv preprint -> https://arxiv.org/abs/2310.03008 + +## Online documentation +Check the online documentation at this link. ## Install Julia If you are new to Julia, here is how to install it. @@ -57,6 +63,3 @@ where you want to replace "6" with the number of threads that you wish to use. A * **runs**: contains run_*.jl files which can be used as a template to run the code * **src**: contains the source code * **starthere**: contains an ipynb notebook written in Julia which walks you through bits and pieces of the code with explanatory plots *(the notebook is evolving over time but always ready to use)* - -## Online documentation -Check the online documentation at this link.