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.

Sign up for GitHub

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

Jump to bottom

Improve the documentation #449

Open

daviesje opened this issue Dec 11, 2024 · 0 comments

Contributor

daviesje commented Dec 11, 2024

A few things missing from the documentation that would be nice to have:

A full table with the units of all input parameters and output structures
A better way to describe certain parameter dependencies
- This should probably be as a section with each major mode of running (default, halo sampler, minihalos...) and the important parameters for each mode
- In future the dependenceies should be handled automatically but this will be much faster
We should be very clear about which parameters are provided in log10

daviesje added this to 21cmFAST v4

daviesje converted this from a draft issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment