add plugin handling for waveforms #3319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cdcapano
approved these changes
Jun 18, 2020
There was a problem hiding this comment.
This is great! Some documentation on how to use this would be good (e.g., what functions are required? Does the approximant name need to be unique and distinct from one currently in the waveform module? What happens if you use the same approximant name?), but I take it you plan to do that in a separate PR? Anyway, looks fine to me.
|
@cdcapano @spxiwh I've updated this PR with docs. Please see https://www.atlas.aei.uni-hannover.de/work/ahnitz/projects/prs/_gh-pages/latest/html/waveform_plugin.html for an example. |
lenona
pushed a commit
to lenona/pycbc
that referenced
this pull request
Sep 14, 2020
* add plugin handling for waveforms * cc * cc * add debugging, don't require m1/m2 for all waveforms * add waveform plugin docs * ws * forgot to commit this * Collin's comments * test
OliverEdy
pushed a commit
to OliverEdy/pycbc
that referenced
this pull request
Apr 3, 2023
* add plugin handling for waveforms * cc * cc * add debugging, don't require m1/m2 for all waveforms * add waveform plugin docs * ws * forgot to commit this * Collin's comments * test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If the plugin is simply installed, pycbc will automatically pick it up and its waveform models will be available from PyCBC. I think this is the behavior we would like for external packages. The hook is the standard Python mechanism using the 'entrypoint' system of 'pkg_resources', which was explicitly designed for this purpose.
It would be good if you all could sign off on the generic interface and merge this first. In the next PR, I'll add documentation to main pages on how to use this both from the package level and how to add a waveform within a single script (by calling pycbc.waveform.add_custom_waveform). That will be followed up by the corresponding tutorial example (which we want for the workshop next week).