Skip to content

Commit

Permalink
add documentation badge
Browse files Browse the repository at this point in the history
  • Loading branch information
jishnub committed Jul 18, 2020
1 parent 815af65 commit 531e9d9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![Build Status](https://ci.appveyor.com/api/projects/status/github/jishnub/WignerDMatrices.jl?svg=true)](https://ci.appveyor.com/project/jishnub/WignerDMatrices-jl)
[![Codecov](https://codecov.io/gh/jishnub/WignerDMatrices.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jishnub/WignerDMatrices.jl)
[![Coveralls](https://coveralls.io/repos/github/jishnub/WignerDMatrices.jl/badge.svg?branch=master)](https://coveralls.io/github/jishnub/WignerDMatrices.jl?branch=master)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://jishnub.github.io/WignerDMatrices.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jishnub.github.io/WignerDMatrices.jl/dev)

Wigner D and d matrices following [Feng et al. (2015)](https://arxiv.org/abs/1507.04535) and the phase convention used by Varshalovich [1988]. The D matrix is defined as

Expand Down
4 changes: 2 additions & 2 deletions src/wignerdeval.jl
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ true
wignerdmatrixelement(j::Real, m, n, β::Real, v = eigenvecsJy!(j)) = wignerdmatrixelement(HalfInt(j), m, n, β, v)

"""
wignerDmatrixelement(j::Real, m, n, β::Real, [v = WignerDMatrices.eigenvecsJy!(j)])
wignerDmatrixelement(j::Real, m, n, (α, β, γ)::NTuple{3,Real}, [v = WignerDMatrices.eigenvecsJy!(j)])
Compute the element ``D^j_{m,n}(β)`` of the Wigner D-matrix in the z-y-z convention.
Compute the element ``D^j_{m,n}(α, β, γ)`` of the Wigner D-matrix in the z-y-z convention.
Optionally the matrix `v` that contains the transposed eigenvectors of the angular momentum
operator `Jy` corresponding to `j` may be provided.
Expand Down

0 comments on commit 531e9d9

Please sign in to comment.