mirror of
https://github.com/tgorordo/WignerSymbols.jl.git
synced 2026-06-05 15:42:15 -07:00
update README
This commit is contained in:
parent
396bc52d2e
commit
8854cfbb97
1 changed files with 4 additions and 9 deletions
13
README.md
13
README.md
|
|
@ -1,5 +1,7 @@
|
|||
# WignerSymbols
|
||||
|
||||
[](http://pkg.julialang.org/?pkg=WignerSymbols)
|
||||
[](http://pkg.julialang.org/?pkg=WignerSymbols)
|
||||
[](https://travis-ci.org/Jutho/WignerSymbols.jl)
|
||||
[](LICENSE.md)
|
||||
[](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.
|
||||
|
||||
## 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.~~
|
||||
|
||||
Now works from Julia v0.6.0 onwards (by including/backporting the relevant code from Julia Base in this package).
|
||||
|
||||
Latest version is compatible with Julia v0.7- only, but older versions can be installed on Julia v0.6.
|
||||
|
||||
## Installation
|
||||
~~Until it is registered, install via `Pkg.clone("https://github.com/Jutho/WignerSymbols.jl.git")`.~~
|
||||
|
||||
Now that it is register, install via `Pkg.add("WignerSymbols")`.
|
||||
Install via `Pkg.add("WignerSymbols")`.
|
||||
|
||||
## 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.
|
||||
|
|
@ -47,8 +44,6 @@ Also uses ideas from
|
|||
|
||||
for caching the computed 3j and 6j symbols.
|
||||
|
||||
## Benchmark
|
||||
|
||||
## Todo
|
||||
* Wigner 9-j symbols, as explained in [1] and based on
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue