Update create_abd_from_h5 to include other post-processing options; update documentation
#92
Conversation
Add description of BMS frames (i.e., scri.asymptotic_bondi_data.map_to_superrest_frame) and how to use scri.SpEC.file_io.create_abd_from_h5 to process SpECTRE CCE output.
docs/tutorial_abd.rst
Outdated
| t_0_superrest=1600, | ||
| padding_time=200 | ||
| ) | ||
| >>> h = scri.asymptotic_bondi_data.map_to_superrest_frame.MT_to_WM(2.0*abd.sigma.bar) |
There was a problem hiding this comment.
So this call was non-intuitive to me, even after reading the entire ABD tutorial, including what you added here. Here are a few thoughts to consider for making this easier to understand:
- Having a section in this ABD tutorial on how to get the strain from an ABD object. This would state that
h=2\bar{\sigma}(though currently the ABD tutorial states it's without a factor of 2?), that we need to convert from the ABD representation to a WaveformModes (which my understanding is whatMT_to_WMdoes, maybe linking to the tutorial for that?), and then also linking again to the WM tutorial section "Working with WaveformModes". - Having somewhere, either here or in the "Working with WaveformModes" an explanation of how to plot the (2,2) of the strain. I expect this is something that someone will want to do as a first sanity check (that's what I was trying to do as a first sanity check) and so we should essentially spoon feed this :)
- Adding a code comment or a description after this code block that just points folks to where they can find the details on this last line. Again, the "Working with WaveformModes" seems like the right place, but I don't know :)
There was a problem hiding this comment.
I think 2. of Nils' suggestions is probably the most important, because yeah I agree that people will just want to see a waveform when they are first trying this out. If they want to do more complicated things they'll have to read the papers and such.
I also agree there should be links to the docs on what a WaveformModes object is and does
There was a problem hiding this comment.
Ok I can just link to https://github.com/moble/scri/blob/main/docs/tutorial_waveformmodes.rst for 2.
docs/tutorial_abd.rst
Outdated
| t_0_superrest=1600, | ||
| padding_time=200 | ||
| ) | ||
| >>> h = scri.asymptotic_bondi_data.map_to_superrest_frame.MT_to_WM(2.0*abd.sigma.bar) |
There was a problem hiding this comment.
I think 2. of Nils' suggestions is probably the most important, because yeah I agree that people will just want to see a waveform when they are first trying this out. If they want to do more complicated things they'll have to read the papers and such.
I also agree there should be links to the docs on what a WaveformModes object is and does
Update the
create_abd_from_h5function to include other post-processing, i.e., time translate by the worldtube radius, scale out the total Christodoulou mass to make waveforms dimensionless, interpolate on to some coarser time array, and map to some reasonable BMS frame. Documentation in docs/tutorial_abd.rst has also been updated.