tgorordo/WignerSymbols.jl
1
0
Fork 0
mirror of https://github.com/tgorordo/WignerSymbols.jl.git synced 2026-06-13 02:02:14 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update README

Browse source
This commit is contained in:
Jutho Haegeman 2018-07-25 00:32:51 +02:00
parent 396bc52d2e
commit 8854cfbb97
1 changed files with 4 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,5 +1,7 @@
# WignerSymbols # WignerSymbols
[![WignerSymbols](http://pkg.julialang.org/badges/WignerSymbols_0.7.svg)](http://pkg.julialang.org/?pkg=WignerSymbols)
[![WignerSymbols](http://pkg.julialang.org/badges/WignerSymbols_0.6.svg)](http://pkg.julialang.org/?pkg=WignerSymbols)
[![Build Status](https://travis-ci.org/Jutho/WignerSymbols.jl.svg?branch=master)](https://travis-ci.org/Jutho/WignerSymbols.jl) [![Build Status](https://travis-ci.org/Jutho/WignerSymbols.jl.svg?branch=master)](https://travis-ci.org/Jutho/WignerSymbols.jl)
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)
[![Coverage Status](https://coveralls.io/repos/Jutho/WignerSymbols.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/Jutho/WignerSymbols.jl?branch=master) [![Coverage Status](https://coveralls.io/repos/Jutho/WignerSymbols.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/Jutho/WignerSymbols.jl?branch=master)
@ -8,15 +10,10 @@
Compute Wigner's 3j and 6j symbols, and related quantities such as Clebsch-Gordan coefficients and Racah's symbols. Compute Wigner's 3j and 6j symbols, and related quantities such as Clebsch-Gordan coefficients and Racah's symbols.
## Requirements ## Requirements
~~This requires a recent master edition of Julia (i.e. v0.7.0-DEV), because it depends on some changes in `Base.GMP`. In particular, it uses the mutating functions for reducing allocation overhead while working with `BigInts` (namely [JuliaLang/julia#21654](https://github.com/JuliaLang/julia/pull/21654)). It also depends on `Primes.jl` for generating prime numbers.~~ Latest version is compatible with Julia v0.7- only, but older versions can be installed on Julia v0.6.
Now works from Julia v0.6.0 onwards (by including/backporting the relevant code from Julia Base in this package).
## Installation ## Installation
~~Until it is registered, install via `Pkg.clone("https://github.com/Jutho/WignerSymbols.jl.git")`.~~ Install via `Pkg.add("WignerSymbols")`.
Now that it is register, install via `Pkg.add("WignerSymbols")`.
## Available functions ## Available functions
While the following function signatures are probably self-explanatory, you can query help for them in the Julia REPL to get further details. While the following function signatures are probably self-explanatory, you can query help for them in the Julia REPL to get further details.
@ -47,8 +44,6 @@ Also uses ideas from
for caching the computed 3j and 6j symbols. for caching the computed 3j and 6j symbols.
## Benchmark
## Todo ## Todo
* Wigner 9-j symbols, as explained in [1] and based on * Wigner 9-j symbols, as explained in [1] and based on