Implement plugin architecture for new instruments - #168
Merged
Conversation
martinjohndyer
left a comment
martinjohndyer
left a comment
Member
There was a problem hiding this comment.
Various comments here @StuartLittlefair, if you're around it might be easier to talk through them in person? I tried to take the position of someone totally independent coming in, so some of the comments like which card are required or why the API is what it is come from that point of view.
| The |hiper| pipeline supports third-party instruments through a plugin system | ||
| based on Python entry-points. A plugin is a Python module that exposes a | ||
| small set of classes and a helper function, which the pipeline uses to read raw | ||
| data and present it as a stream of :class:`~hipercam.MCCD` objects. |
Member
There was a problem hiding this comment.
These auto hyperlinks don't actually work at the moment, since we don't build the full autoapi. We can enable that (there's the autoapi_generate_api_docs param in config.py), but it takes a while and there are loads of warnings which is why I didn't in #161. Could be part of a larger refresh of the docs.
proper import of astropy fits module Co-authored-by: Martin Dyer <martin.dyer@sheffield.ac.uk>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR fixes #150 by adding a plugin system for third-party instruments.
In the end, the plugin only implements the
Rdataclass for each new instrument, not classes likeRtime,Rheadetc. My opinion was that these were only used for ultra|hipercam specific scripts likehloggerand all the main functionality is supported just with the use ofRdata.The only exception I think it
ltimes.py, but I don't think supporting this single script is work it.