Skip to content

Commit

Permalink
Update create_abd_from_h5 options
Browse files Browse the repository at this point in the history
  • Loading branch information
moble authored Jun 3, 2024
1 parent abfc78e commit 947264e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/tutorial_abd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,9 +308,9 @@ In particular, it takes as input:

* ``padding_time``, the time window about ``t_0`` to be used when finding the BMS transformation to the superrest frame.

========================================================
Creating an AsymptoticBondiData Object from a CCE Output
========================================================
============================================
Loading CCE data and adjusting the BMS frame
============================================

For processing the output of SpECTRE CCE, one may use the function ``scri.SpEC.file_io.create_abd_from_h5``.
This function takes as input the path to SpECTRE CCE's output file (via the option ``file_name``) and
Expand Down Expand Up @@ -342,11 +342,11 @@ Example usage of this function could be:
>>> import scri
>>> import matplotlib.pyplot as plt
>>> abd = scri.SpEC.file_io.create_abd_from_h5(
file_name='CharacteristicExtractVolume_R0292.h5',
file_format="spectrecce",
ch_mass=1.0,
t_interpolate=t_worldtube,
>>> abd = scri.create_abd_from_h5(
file_name="CharacteristicExtractVolume_R0292.h5",
file_format="spectrecce_v1",
# ch_mass=1.0, # Optional; helpful if known
# t_interpolate=t_worldtube, # Optional; for some specified values of `t_worldtube`
t_0_superrest=1600,
padding_time=200
)
Expand Down

0 comments on commit 947264e

Please sign in to comment.