Project Event Model Configurations #615
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
…roject_configuration_fix
|
This PR is very dependent on event model work. I have a little more work to do here to update changes that were recently merged into event model, so let's not merge this until I've completed that. |
…roject_configuration_fix
danielballan
reviewed
Nov 5, 2020
databroker/projector.py
Outdated
| """Produces an xarray Dataset by projecting the provided run. Selects projection based on | ||
| logic of get_run_projection(). | ||
| class Projector(): | ||
| """Handles much of the inner workings of projecting a BlueskyRun by scanning the |
There was a problem hiding this comment.
Sphinx will format this more nicely if you do
Single-line summary
<blank line>
Optional paragraph with more detail
databroker/projector.py
Outdated
| All projections with "location"="configuration" will look in the start document | ||
| for metadata. Each field will be added to the return Dataset's attrs dictionary keyed | ||
| on projection key. | ||
| def project_xarray(run: BlueskyRun, *args, projection=None, projection_name=None, **kwargs): |
There was a problem hiding this comment.
Swallowed? If so remove because this makes it easy for typos to pass unnoticed.
|
Do you have a formal format for marking "experimental" or is it as simple as saying it in the docstring? |
|
We just put it in the docstring. There has been a move toward more formality around this in some projects, but it's not yet widespread. Could consider it in the future. |
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.
This PR primarily enhances projections to add a projection type for capturing Event Descriptor Configuration field. It is tied to a PR in event model: bluesky/event-model#192
In addition to adding this field type, I refactored the project_xarray function, creating a Projector class that handles the mechanics of parsing a projection. It uses callbacks to communicate to a caller. The project_xarray function now uses the Projector class, and is now handling only the construction of a return xarray.Dataset.