pygdsm icon indicating copy to clipboard operation
pygdsm copied to clipboard

Improve documentation

Open telegraphic opened this issue 3 years ago • 5 comments

As GSM08 and GSM16 do not seem to be supported by their authors anymore, it would be useful to make a note of the issues with the code (e.g. #11 ), the 45 MHz scale offset bug in GSM16.

On the topic of documentation, I have not made it clear about whether the CMB is included in maps. I should do so -- this could be done with an extra include_cmb=False argument.

telegraphic avatar Nov 11 '22 07:11 telegraphic

So can you say in short, whether the CMB is included in the maps?

MaxNeksueb avatar Apr 24 '23 19:04 MaxNeksueb

Hi Max,

At the moment I think it's a mixed bag. For the HaslamSkyModel I subtract it, for the LFSM I think it's not subtracted, and GSM08 I believe it's subtracted, but not for GSM16.

To date, I've tried to keep the code faithfully reproducing the original models. I am inching toward dropping that so that it's more consistent and user-friendly (also #14 suggests improving the interpolation for GSM16).

telegraphic avatar Apr 27 '23 06:04 telegraphic

Hi Danny, thanks. If you kept the models as original as possible for now, I will rely on what the documentations of the individual models say. And regarding those I have the same understanding as what you wrote.

MaxNeksueb avatar Apr 27 '23 06:04 MaxNeksueb

Hey Max, I've just added include_cmb options to the Sky Models

telegraphic avatar Apr 28 '23 09:04 telegraphic

Thanks! Very useful addition

MaxNeksueb avatar Apr 28 '23 09:04 MaxNeksueb