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

[BUG] Inconsistencies in the name of the SUBCELL_RSD option #348

Open
zhaotingchen opened this issue Oct 13, 2023 · 1 comment
Open

[BUG] Inconsistencies in the name of the SUBCELL_RSD option #348

zhaotingchen opened this issue Oct 13, 2023 · 1 comment
Assignees
Labels
bug context: python wrapper Predominantly affecting the Python wrapper priority: medium type: documentation Improvements or additions to documentation

Comments

@zhaotingchen
Copy link

Describe the bug:
Not really a bug, but in the python interface, the parameter for turning on the is (p21c.FlagOptions._defaults_)['SUBCELL_RSD']. But in the documentation, the parameter is named as SUBCELL_RSDS with a trailing ``S''.

Expected behavior:
Consisntencies between the documentation and the code.

Details:

  • 21cmFAST version 3.3.1

I want to also use this opportunity to ask if there is any other parameter to tune for getting the RSD effects. In particular, I am not sure if T_USE_VELOCITIES in GlobalParams should be turned on. It seems to me that SUBCELL_RSD is a more accurate version, but I am not too sure.

@steven-murray steven-murray self-assigned this Oct 23, 2023
@steven-murray steven-murray added type: documentation Improvements or additions to documentation context: python wrapper Predominantly affecting the Python wrapper priority: medium labels Oct 23, 2023
@steven-murray
Copy link
Member

Thanks @zhaotingchen. We can update the documentation for this. I don't think there's anything you should need to tune for RSDs. You can choose the axis of the box that is used as the LoS direction, but there's no real point in changing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug context: python wrapper Predominantly affecting the Python wrapper priority: medium type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants