Skip to content

Commit 947264e

Browse files
authored
Update create_abd_from_h5 options
1 parent abfc78e commit 947264e

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/tutorial_abd.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -308,9 +308,9 @@ In particular, it takes as input:
308308

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

311-
========================================================
312-
Creating an AsymptoticBondiData Object from a CCE Output
313-
========================================================
311+
============================================
312+
Loading CCE data and adjusting the BMS frame
313+
============================================
314314

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

0 commit comments

Comments
 (0)