diff --git a/README.md b/README.md index f04a5b3..ad88a85 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![](https://img.shields.io/badge/Documentation-dev-blue.svg)](https://eigensolver.github.io/SpinShuttling.jl/dev/) ![action-ci](https://github.com/eigensolver/SpinShuttling.jl/actions/workflows/runtest.yml/badge.svg) -Simulate the open-system dynamics of a moving spin under correlated stoathstic noise. +Simulate the open-system dynamics of a moving spin under correlated stochastic noise. Install the package using the Julia package manager. From the Julia REPL, type `]` to enter the Pkg REPL mode and run @@ -11,4 +11,11 @@ From the Julia REPL, type `]` to enter the Pkg REPL mode and run pkg> add SpinShuttling ``` -![two_spin_shuttling](./docs/src/assets/animation2spins.gif) \ No newline at end of file +## Example: + +![Sequential shuttling of a pair of entangled qubit](./docs/src/assets/animation2spins.gif) + + +The quickstart page has a longer example. See the [documentation](https://eigensolver.github.io/SpinShuttling.jl/dev/) for details. + +If you use SpinShuttling.jl in your research, please [cite](CITATION.bib) our work.