Skip to content

Commit

Permalink
Document comparison notebook in README
Browse files Browse the repository at this point in the history
  • Loading branch information
duetosymmetry committed Sep 24, 2019
1 parent 45a5199 commit 73cc0f9
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ details](#spherical-spheroidal-decomposition)).
Visual inspections of modes are very useful to check if the solver is
behaving well. This is easily accomplished with matplotlib. Here are
some partial examples (for the full examples, see the file
`notebooks/examples.ipynb` in the source repo):
[`notebooks/examples.ipynb`](notebooks/examples.ipynb) in the source repo):

```python
import numpy as np
Expand Down Expand Up @@ -146,6 +146,21 @@ Which results in the following figure (modulo formatting):

![example_2m0 plot](notebooks/example_2m0.png)

## Precision and validation

The default tolerances for continued fractions, `cf_tol`, is 1e-10, and
for complex root-polishing, `tol`, is DBL_EPSILON≅1.5e-8. These can
be changed at runtime so you can re-polish the cached values to higher
precision.

[Greg Cook's precomputed data
tables](https://zenodo.org/record/2650358) (which were computed with
arbitrary-precision arithmetic) can be used for validating the results
of this code. See the comparison notebook
[`notebooks/Comparison-against-Cook-data.ipynb`](notebooks/Comparison-against-Cook-data.ipynb)
to see such a comparison, which can be modified to compare any of the
available modes.

## Spherical-spheroidal decomposition

The angular dependence of QNMs are naturally spin-weighted *spheroidal*
Expand Down

0 comments on commit 73cc0f9

Please sign in to comment.