History fields table missing from CLM5 Users Guide

[katiedagon]

The table of history fields is missing from the current users guide (section 1.2.3.1.3, Table 1.3)
https://escomp.github.io/ctsm-docs/doc/build/html/users_guide/setting-up-and-running-a-case/customizing-the-clm-namelist.html#table-1-3-clm-history-fields

Several of the links on that page are also broken (e.g., section 1.2.3.1 and section 1.2.3.1.1)

[billsacks]

Blocked by #34

[billsacks]

@slevisconsulting @katiedagon @danicalombardozzi @dlawrenncar @wwieder I just rebuilt the documentation with @slevisconsulting 's changes . You can find the table here: https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/setting-up-and-running-a-case/master_list_file.html

[dlawrenncar]

Only 1264 variables. :) When I look at the table, at least in Chrome, the long name is cutoff for many variables unless you scroll all the way to the bottom and pull across. Maybe no way to resolve this, but it's a bit awkward. Perhaps not worth any additional time though. Also, this is a list of ALL possible output including variables that are not output by default, correct? Would it be easy to add whether or not a variable is default active or inactive. If not easy, again, probably not worth extra time.

…

On Fri, Nov 20, 2020 at 4:15 PM Bill Sacks ***@***.***> wrote: @slevisconsulting <https://github.com/slevisconsulting> @katiedagon <https://github.com/katiedagon> @danicalombardozzi <https://github.com/danicalombardozzi> @dlawrenncar <https://github.com/dlawrenncar> @wwieder <https://github.com/wwieder> I just rebuilt the documentation with @slevisconsulting <https://github.com/slevisconsulting> 's changes . You can find the table here: https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/setting-up-and-running-a-case/master_list_file.html — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#941 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFABYVBSLZ5KWFHG66U55F3SQ32ALANCNFSM4LGTVEUA> .

[billsacks]

Yes, I was a bit confused by the need to find the scroll bar at the bottom, too. For what it's worth, it worked for me to use the right arrow key to scroll, avoiding the need to scroll to the bottom. Maybe not an ideal solution.

@slevisconsulting I'll let you reply to @dlawrenncar 's comment, too.

[danicalombardozzi]

Yes, it's very exciting to have the table! Related to the size of the table, it looks like the user's guide is set to a fixed width and that may be part of the problem. I've seen the same thing with the CLM Tech Note -- some of the crop tables are wider than the rendered documentation, forcing you to scroll over. Another question: Is it easy to alphabetize the variables so that they're easier to find? If that's a huge pain, it's probably not necessary.

…

On Fri, Nov 20, 2020 at 5:23 PM Bill Sacks ***@***.***> wrote: Yes, I was a bit confused by the need to find the scroll bar at the bottom, too. For what it's worth, it worked for me to use the right arrow key to scroll, avoiding the need to scroll to the bottom. Maybe not an ideal solution. @slevisconsulting <https://github.com/slevisconsulting> I'll let you reply to @dlawrenncar <https://github.com/dlawrenncar> 's comment, too. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#941 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGHW2QND5BSZDT7B62ZUB7DSQ4B7PANCNFSM4LGTVEUA> .

-- Dr. Danica Lombardozzi she/her/hers Terrestrial Sciences Section Climate and Global Dynamics National Center for Atmospheric Research Boulder, CO 80305 email: dll@ucar.edu office: (303) 497-1777

[slevis-lmwg]

@dlawrenncar a first attempt shows me that your request for a list of variable status (active is T or F) is very straightfwd.

@danicalombardozzi alphabetizing seems like a good idea, too. I can look into a way of doing that, unless @billsacks has a shortcut suggestion off the top of his head.

[billsacks]

From a quick look for whether we have any generic sorting methods, I can't find any. But we do have an inline sort in another place in histFileMod that could be reused for this purpose: see ! Sort each list of active entries. It's an inefficient sort (O(n^2)), but for this purpose it should be okay. I think that, with just a bit of work, one could make a generic routine that operates on either history tape entries (as is currently done) or the master field list (as is needed in this new case)... but I'm also okay with reuse-via-copy-and-paste in this case, since it isn't critical that the two reuse the same method.

[billsacks]

(But I'd also be happy to help with the changes needed to make this a generic routine if you'd like, if you don't see how... basically it will involve some object-orientation tricks. I'm fine either way.)