sunpy / sunkit-instruments

A SunPy-affiliated package for solar instrument-specific tools.
https://docs.sunpy.org/projects/sunkit-instruments/
BSD 3-Clause "New" or "Revised" License
11 stars 14 forks source link

Add a topic guide for response function vocabulary #111

Open wtbarnes opened 1 year ago

wtbarnes commented 1 year ago

This PR tackles the same problem as #99 but takes the approach of using a topic guide page rather than a glossary. My reasoning here was that the explanations needed for each entry felt too long for just a glossary page. We could still certainly have a glossary page that has short descriptions or links to this more expanded page.

This PR is the result of conversations with @namurphy, @joyvelasquez, @jslavin, and @kreevescfa. I would appreciate everyone having a read over this and making sure they agree!

To see the rendered version, click here.

joyvelasquez commented 1 year ago

Hi Will, thank you for compiling these note. The XRTpy team will review it and respond to you soon.

wtbarnes commented 1 year ago

One thought was that with the glossary, we would have been able to use :term:temperature response to link to the definition.

That's a good point. Would it make sense for a topic guide in this format to coexist with a glossary? Or would that be redundant?

joyvelasquez commented 9 months ago

Overall, this guide seems like a valuable resource for users of aiapy and xrtpy, offering a solid foundation in understanding instrument response functions. Thanks @wtbarnes !

wtbarnes commented 7 months ago

@jacobdparker @ayshih I'd be interested to have your perspectives on this as you two have thought more about the correct definitions of these terms.

wtbarnes commented 3 months ago

Feedback from @jacobdparker is that "transmittance" -> "transmissivity" and "reflectance"->"reflectivity"

wtbarnes commented 3 months ago

@byrdie you probably have thoughts on this as well

byrdie commented 3 months ago

Regarding reflectance vs reflectivity, I see both a lot but reflectivity seems to be more common in our community. I generally prefer reflectivity, but Google ngram shows that reflectance is more common

wtbarnes commented 2 months ago

Regarding reflectance vs reflectivity, I see both a lot but reflectivity seems to be more common in our community. I generally prefer reflectivity, but Google ngram shows that reflectance is more common

Given that, I'll stick with transmittance/reflectance for now. The AIA calibration paper also uses transmittance and reflectance.

byrdie commented 2 months ago

The nice thing about reflectance/transmittance too is that it lets you use absorbance instead of absorptivity which seems more natural and easier to say.

namurphy commented 1 month ago

Thank you so much for doing this! I'm really liking how it's turning out, and this page has the potential to be helpful to the solar physics community as a whole (and perhaps beyond).