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

Calc dissolved volatiles documentation #152

Open
PennyWieser opened this issue Aug 10, 2021 · 2 comments
Open

Calc dissolved volatiles documentation #152

PennyWieser opened this issue Aug 10, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@PennyWieser
Copy link
Collaborator

When I do
help(v.calculate_dissolved_volatiles)
I can't actually see X_fluid described in the Parameters in the documentation (unless I'm being stupid?)
Not sure exactly where you want to add it, but I think it should specify:

  1. If its mole or mass fraction
  2. that X_fluid=1 is all H2O, X_fluid=0 is all CO2.

Also, it has pressure but not temperature as a parameter. Maybe i'm just missing something, I still find classes confusing!

@PennyWieser PennyWieser added the documentation Improvements or additions to documentation label Aug 10, 2021
@PennyWieser
Copy link
Collaborator Author

Similarly, I can't see an explanation of the "init_vapor" parameter in calculate_degasing_path help documentation

@simonwmatthews
Copy link
Collaborator

Sorry, I just saw this. It's because the calculate_dissolved_volatiles method doesn't need those parameters- its just some of the models might. I don't think there's a way of automatically transmitting that information, though there could be. The way I've got around this for a similar problem in pyMelt is to add a Notes section to the documentation which goes through the additional arguments required by each method.

I can try to do this at some point, though it won't be for a few weeks.

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

3 participants