-
Notifications
You must be signed in to change notification settings - Fork 10
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
add cooling documentation #97
base: main
Are you sure you want to change the base?
Conversation
This might belong in another PR, but we could make some functional changes to AthenaPK to reduce errors and bring cooling and treatment of temperatures more inline with the code:
Another larger change that I don't think belongs in this PR would be to address temperature units:
|
I would be in favor of this change. I do not agree with the other proposed changes. In particular, I think Kelvins are the only physical temperature unit that anyone would ever use. I think requiring input in code units would make human error more likely. |
That's very fair, my programmer brain for consistency is usually wrong. There goes my dream of a code using Rankine though |
If we include the updated Schure Cooling table (or tables for different metallicities) I think we should include this notebook in some form, perhaps reduced down to a small script without the plots: schure_cooling.ipynb.txt |
I think a notebook with plots included would be good to include in the docs. Or maybe a docs/notebooks subfolder? |
This adds a Markdown file with documentation on the convention for CIE cooling curves that is expected by AthenaPK, as well as documenting the approximations used in calculating the mean molecular weight.
A script to plot two example cooling curves in the form expected by AthenaPK is provided.