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

Documentation is confusing on use of rad/degrees #50

Open
MijnheerD opened this issue Nov 21, 2022 · 2 comments
Open

Documentation is confusing on use of rad/degrees #50

MijnheerD opened this issue Nov 21, 2022 · 2 comments

Comments

@MijnheerD
Copy link
Collaborator

The homepage mentions that the default unit for angles is radians, however everywhere in the documentation and examples degrees are used. This is particularly confusing when looking at the documentation of the __init__ function for cstrafo, where the zenith and azimuth descriptions are in degrees. If this could be updated to use radians instead, it would help first time users like me tremendously 👍🏽

@MijnheerD
Copy link
Collaborator Author

On a related note (I don't think this really deserves a separate issue), the azimuth description in the __init__ function of cstrafo is bit weird: "azimuth angle of the incoming signal/air-shower direction (0 deg is North, 90 deg is South)". Shouldn't it be +90 deg (or preferably +pi/2) is North, -90 deg (-pi/2) is South?

@fschlueter
Copy link
Collaborator

Hi, sorry that flipped my intention. To the first comment: I partially disagree, I think it is still useful to write values in deg to describe the geometry conventions we are using. After all using radians in "spoken" language is weird. As a compromise, why not writing both: South is at pi / 2 (90 deg)?

However, It would be appreciated if you could do propose and implement changes and create Pull-Request.

To your second comment: This seems indeed wrong. If North is at 0 deg, West should be at 90 deg. However, I would argue that this is not strictly true. The magnetic field vector defined what is North. If you give pass a vector [0, 0.5, 0.5], North will be at 90 deg (in the y-z plane). However, I assume that the default magnetic field vectors which are defined with the side follow the convention that the vector is in the x-z plane. Can you comment on this @cg-laser

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

No branches or pull requests

2 participants