Skip to content

Commit

Permalink
fix export
Browse files Browse the repository at this point in the history
  • Loading branch information
EigenSolver committed Mar 8, 2024
1 parent 0639f88 commit 27f16d3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
31 changes: 28 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SpinShuttling.jl
# SpinShuttling.jl

*Simulate the multiple-spin shuttling problem under correlated stochastic noise.*

## Installation
## Installation

SpinShuttling can be installed using the Julia package manager.
From the Julia REPL, type `]` to enter the Pkg REPL mode and run
Expand All @@ -12,10 +12,12 @@ pkg> add SpinShuttling
```

## APIs

```@meta
CurrentModule = SpinShuttling
```

### Spin Shuttling Models

```@docs
OneSpinModel
Expand All @@ -33,6 +35,8 @@ TwoSpinModel
TwoSpinParallelModel
```

### Fidelity Metric

```@docs
fidelity
```
Expand All @@ -45,6 +49,12 @@ sampling
averagefidelity
```

```@docs
φ
```

### Stochastics

```@docs
OrnsteinUhlenbeckField
```
Expand All @@ -58,6 +68,21 @@ RandomFunction
```

```@docs
φ
CompositeRandomFunction
```

```@docs
characteristicfunction
```

```@docs
characteristicvalue
```

```@docs
covariancematrix
```

```@docs
covariance
```
2 changes: 1 addition & 1 deletion src/SpinShuttling.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ include("analytics.jl")
include("stochastics.jl")

export ShuttlingModel, OneSpinModel, TwoSpinModel,
OneSpinForthBackModel, TwoSpinParallelModel, RandomFunction, CompositeRandomFunction
OneSpinForthBackModel, TwoSpinParallelModel, RandomFunction, CompositeRandomFunction,
OrnsteinUhlenbeckField, PinkBrownianField
export averagefidelity, fidelity, sampling, characteristicfunction, characteristicvalue
export covariance, covariancematrix
Expand Down

0 comments on commit 27f16d3

Please sign in to comment.