Vital-Fernandez / lime

Line Measuring library in python
Other
16 stars 6 forks source link

Replacing gaussian_flux and gaussian_flux_err variables/headers names #28

Open Vital-Fernandez opened 11 months ago

Vital-Fernandez commented 11 months ago

In a nearby future update, LiMe will include support for Lorentz/Cauchy and Voigt profiles. This has required the following updates:

These are backend changes which should not affect most users but at this point we should also change the name of the gaussian_flux_err variables/headers in the output measurement files. This is a small change but it is likely to affect users (better to do it before the release).

I was thinking of always leaving the output columns in similar positions and independenlty of the profile use the same variable name. I was planing in replacing the gaussian_fluxand gaussian_flux_err by profile_fluxand profile_flux_err. Another options could be curve_flux, fitted_flux...

Knusper commented 1 month ago

Changes that break the API are OK, as long as they are proper documented and announced.

However, what I don't understand is, why gaussian_flux can not remain gaussian_flux, whereas the profiles fitted with other profiles are named lorentz_flux etc. - a general profile_flux could still exist, which just points to either one of these... But again, I'm OK with such an incompatible change, as it is just a matter of search and replace in code using this library. I vote for profile_flux.