Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update
create_abd_from_h5
to include other post-processing options; update documentation #92Update
create_abd_from_h5
to include other post-processing options; update documentation #92Changes from 1 commit
d41b3c7
d253ea4
37c27ae
48cf5a7
e9a9649
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
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_WM
does, maybe linking to the tutorial for that?), and then also linking again to the WM tutorial section "Working with WaveformModes".There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 doesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I can just link to https://github.com/moble/scri/blob/main/docs/tutorial_waveformmodes.rst for 2.