Skip to content

Commit

Permalink
Clarified info in README.md
Browse files Browse the repository at this point in the history
Added the DOIs for the bibliography, as well as corrected the compiling instructions.
  • Loading branch information
joeydumont committed Oct 29, 2015
1 parent 6507ea1 commit e11b4a2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Wigner Symbols
==============

[![Join the chat at https://gitter.im/valandil/wignerSymbols](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valandil/wignerSymbols?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11076.png)](http:https://dx.doi.org/10.5281/zenodo.11076)
[![DOI](https://zenodo.org/badge/5354/valandil/wignerSymbols.svg)](https:https://zenodo.org/badge/latestdoi/5354/valandil/wignerSymbols)

A C++ ensemble of functions to compute the Wigner 3j- and 6j- symbols. It reimplements the algorithm designed
by Schulten and Gordon in C++, but also contains the original Fortran implementation.
Expand All @@ -20,6 +20,7 @@ This library uses CMake to help the build process. First, download the source co
It is recommended to create a separate directory for building, i.e.
```bash
mkdir build/
cd build/
```
Then, run
```bash
Expand Down Expand Up @@ -58,14 +59,19 @@ evaluation of Wigner symbols.

### Fortran implementation

+ `std::vector<double> wigner3j_f(double l2, double l3, double m1, double m2, double m3)` <br />
Computes Wigner 3j symbols with all possible values of `l1`.
+ `double wigner3j_f(double l1, double l2, double l3, double m1, double m2, double m3)`<br />
Computes a specific Wigner 3j symbol.
+ `double clebschGordan_f(double l1, double l2, double l3, double m1, double m2, double m3)`<br />
Computes a specific Clebch-Gordan coeffcient.
+ `std::vector<double> wigner6j_f(double l2, double l3, double l4, double l5, double l6)` <br />
Computes Wigner 6j symbols with all possible values of `l1`.
+ `double wigner6j_f(double l1, double l2, double l3, double l4, double l5, double l6)`<br />
Computes a specific Wigner 6j symbol.

## Bibliography
+ K. Schulten and R. G. Gordon, _Recursive evaluation of 3j and 6j coefficients_, Comput. Phys. Commun. **11**, 269–278 (1976).
+ K. Schulten, _Exact recursive evaluation of 3j- and 6j-coefficients for quantum-mechanical coupling of angular momenta,_ J. Math. Phys. **16**, 1961 (1975).
+ K. Schulten and R. G. Gordon, _Recursive evaluation of 3j and 6j coefficients_, Comput. Phys. Commun. **11**, 269–278 (1976). DOI: [10.1016/0010-4655(76)90058-8](/http:https://dx.doi.org/10.1016/0010-4655(76)90058-8)
+ K. Schulten, _Exact recursive evaluation of 3j- and 6j-coefficients for quantum-mechanical coupling of angular momenta_, J. Math. Phys. **16**, 1961 (1975). DOI: [10.1063/1.522426](http:https://dx.doi.org/10.1063/1.522426).
+ J. Luscombe and M. Luban, _Simplified recursive algorithm for Wigner 3j and 6j symbols_, Phys. Rev. E **57**, 7274–7277 (1998). DOI: [10.1103/PhysRevE.57.7274](http:https://dx.doi.org/10.1103/PhysRevE.57.7274).

0 comments on commit e11b4a2

Please sign in to comment.