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

Insufficient documentation for COMPUTE_TREELINE and JULY_TAVG_SUPPLIED #58

Closed
tbohn opened this issue Sep 27, 2013 · 4 comments
Closed
Assignees
Milestone

Comments

@tbohn
Copy link
Contributor

tbohn commented Sep 27, 2013

While the COMPUTE_TREELINE and JULY_TAVG_SUPPLIED global parameter options and the July_Tavg soil parameter are described in the online documentation, it is not sufficiently clear to a new user that the July average air temperature needs to be supplied if their simulation does not contain any dates in July.

@ghost ghost assigned tbohn Sep 27, 2013
@tbohn
Copy link
Contributor Author

tbohn commented Sep 27, 2013

I have updated the online documentation as follows:

  1. expanded the description of these options and parameter so that the conditions under which July average air temperature must be supplied are explicitly mentioned (earlier, the reader had to infer the conditions from the description)
  2. added cross links among the definitions of all three of these terms.

The following web pages were updated:
Documentation/GlobalParam.shtml
Documentation/SoilParam.shtml

@tbohn tbohn closed this as completed Sep 27, 2013
@bartnijssen
Copy link
Member

Actually - this should be marked as a bug, because one of the effects is that the model state is not restored as expected under certain conditions, resulting in non-sensical results, without a clear warning.

Expected behavior:
The model should abort with a descriptive error message if COMPUTE_TREELINE is turned on and JULY_TAVG_SUPPLIED is not supplied (or cannot be calculated, but I suggest that JULY_TAVG_SUPPLIED needs to be true to simplify things).

I think the behavior as implemented by Ted is sufficient for 4.1.2.j, but we should have the model fail for 4.2.

@jhamman
Copy link
Member

jhamman commented Sep 25, 2014

I have issued a pull requests that requires JULY_TAVG_SUPPLIED=TRUE when COMPUTE_TREELINE=TRUE. If this condition is not met, a descriptive abort message is given.

@bartnijssen
Copy link
Member

Merged pull request

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

No branches or pull requests

3 participants