Skip to content

Commit

Permalink
Correct READMEs evaluate the surrogate example to match NRSur7dq4 exa…
Browse files Browse the repository at this point in the history
…mple.
  • Loading branch information
sfield17 committed Jan 16, 2025
1 parent dd4bd8e commit 5d32689
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,16 +167,19 @@ sur = gwsurrogate.LoadSurrogate('NRSur7dq4')

## Evaluate the surrogate
```python
q = 4 # mass ratio, mA/mB >= 1.
q = 4 # mass ratio, mA/mB >= 1.
chiA = [-0.2, 0.4, 0.1] # Dimensionless spin of heavier BH
chiB = [-0.5, 0.2, -0.4] # Dimensionless of lighter BH
dt = 0.1 # timestep size, Units of total mass M
f_low = 0 # initial frequency, f_low=0 returns the full surrogate
f_low = 0 # initial frequency, f_low=0 returns the full surrogate

# optional parameters for a precessing surrogate models
precessing_opts = {'return_dynamics': True}

# h is dictionary of spin-weighted spherical harmonic modes
# t is the corresponding time array in units of M
# dyn stands for dynamics, do dyn.keys() to see contents
t, h, dyn = sur(q, chiA, chiB, dt=dt, f_low=f_low)
t, h, dyn = sur(q, chiA, chiB, dt=dt, f_low=f_low, precessing_opts=precessing_opts)
```

There are many more options, such as using MKS units, returning the
Expand Down

0 comments on commit 5d32689

Please sign in to comment.