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

Improve documentation #12

Open
telegraphic opened this issue Nov 11, 2022 · 5 comments
Open

Improve documentation #12

telegraphic opened this issue Nov 11, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@telegraphic
Copy link
Owner

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 telegraphic added the documentation Improvements or additions to documentation label Nov 11, 2022
@telegraphic telegraphic changed the title Improve documentation with model limitations Improve documentation Nov 11, 2022
@MaxNeksueb
Copy link

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

@telegraphic
Copy link
Owner Author

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).

@MaxNeksueb
Copy link

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.

@telegraphic
Copy link
Owner Author

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

@MaxNeksueb
Copy link

Thanks! Very useful addition

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants