Skip to content
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

per-config display of unit selections #3166

Merged
merged 3 commits into from
Sep 9, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Aug 23, 2024

Description

This pull request provides the infrastructure for configs (and downstream apps) to dictate which display units should be shown in the plugin, as well as including a time unit (currently unused for all configs, but needed by lcviz). The individual logic may need to be adjusted as unit conversion is enabled for the remaining configs (I just made a rough guess). This PR also makes the surface-brightness API access read-only.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@kecnry kecnry added the no-changelog-entry-needed changelog bot directive label Aug 23, 2024
@kecnry kecnry added this to the 4.0 milestone Aug 23, 2024
@github-actions github-actions bot added specviz plugin Label for plugins common to multiple configurations labels Aug 23, 2024
@kecnry kecnry force-pushed the unit-conversion-generalize branch 2 times, most recently from 9332f11 to 280eaee Compare August 23, 2024 14:50
Copy link

codecov bot commented Aug 23, 2024

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.41%. Comparing base (cd70c2e) to head (c43f450).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...specviz/plugins/unit_conversion/unit_conversion.py 96.66% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3166   +/-   ##
=======================================
  Coverage   88.40%   88.41%           
=======================================
  Files         124      124           
  Lines       18349    18373   +24     
=======================================
+ Hits        16221    16244   +23     
- Misses       2128     2129    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kecnry kecnry force-pushed the unit-conversion-generalize branch 2 times, most recently from f86e09f to 1e5e725 Compare September 6, 2024 18:08
@rosteen
Copy link
Collaborator

rosteen commented Sep 6, 2024

I just pulled this, and the Unit Conversion plugin doesn't render in Cubeviz (it appears in Specviz as expected).

@kecnry
Copy link
Member Author

kecnry commented Sep 6, 2024

ah, that was a missed update in the rebase, should be fixed now (sorry about that!)

attach
:items="spectral_y_type_items.map(i => i.label)"
v-model="spectral_y_type_selected"
:label="api_hints_enabled ? 'plg.spectral_y_type =' : 'Flux or Surface Brightness'"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you missed this string in the rebase, unless you meant to change it back from the more general language.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, missed that too 🤦 Reverted to "Spectral y-axis Type"

Copy link
Collaborator

@rosteen rosteen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, thanks.

self.angle_unit = UnitSelectPluginComponent(self,
items='angle_unit_items',
selected='angle_unit_selected')

self.has_sb = self.has_angle or self.config in ('imviz',)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self.has_sb = self.has_angle or self.config in ('imviz',)
self._has_sb = self.has_angle or self.config in ('imviz',)

As per "convention," should this be "hidden" then if read only?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Traitlets cannot have leading underscores, and this is not exposed to the user

Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much cleaner code-wise. Thanks! Just a minor question, so approving. Merge at will.

@kecnry kecnry merged commit 3f80eb5 into spacetelescope:main Sep 9, 2024
25 checks passed
@kecnry kecnry deleted the unit-conversion-generalize branch September 9, 2024 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations Ready for final review specviz
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants