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.

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

doxygen documentation for sorc/grid_tools.fd #343

Closed
edwardhartnett opened this issue Feb 23, 2021 · 7 comments
Closed

doxygen documentation for sorc/grid_tools.fd #343

edwardhartnett opened this issue Feb 23, 2021 · 7 comments
Assignees
@edwardhartnett
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Collaborator

Part of #191
@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Feb 23, 2021
@lgannoaa
Copy link
Contributor

In review of this issue, it included 4 directories and 12 f90 source codes. I think it will be helpful if @GeorgeGayno-NOAA can take a view and input high level description document before we can finish this issue with detail doxygen update.

@edwardhartnett
Copy link
Collaborator Author

We need these files doxygenated. Please add doxygen formatting as best you can. Do one or two files and put up a PR, and we will start filling in the missing information.

@lgannoaa lgannoaa self-assigned this Feb 25, 2021
lgannoaa added a commit to lgannoaa/UFS_UTILS that referenced this issue Feb 26, 2021
@lgannoaa
This is a continue work in progress on
5d387a6 
doxygen documentation for sorc/grid_tools.fd ufs-community#343
The grid_tools.fd included 4 directories and 12 f90 source codes.
 Changes to be committed:
       modified:   regional_esg_grid.fd/psym2.f90
       modified:   regional_esg_grid.fd/regional_esg_grid.f90
       modified:   shave.fd/shave_nc.F90
@lgannoaa lgannoaa mentioned this issue Feb 26, 2021
Closed
@edwardhartnett edwardhartnett mentioned this issue Mar 4, 2021
Merged
This was referenced Mar 5, 2021
Merged
Merged
Merged
Merged
@edwardhartnett
Copy link
Collaborator Author

I am working with Jim Purser to get the rest of these question marks filled in...

@edwardhartnett edwardhartnett mentioned this issue Mar 18, 2021
Merged
@edwardhartnett edwardhartnett mentioned this issue Apr 7, 2021
Merged
This was referenced Apr 16, 2021
Merged
Merged
@edwardhartnett
Copy link
Collaborator Author

OK, in sorc/grid_tools.fd/regional_esg_grid.fd there is one file with three remaining undocumented fields, I have sent that to Jim Purser to get the answers.

The other undocumented file is filter_topo.f90. This was written by two GFDL programmers. I have sent the file to Rusty Benson and asked them to fill in the missing fields.

@edwardhartnett
Copy link
Collaborator Author

@bensonr any progress getting the programmers to document their work in filter_topo.f90?

@bensonr
Copy link
Contributor

bensonr commented Apr 22, 2021

@edwardhartnett - there is a section dedicated to the topography filtering algorithm in the soon to be released comprehensive, scientific description of FV3 "the dycore" documentation. As this offline filtering algorithm comes directly from FV3 "the dycore", that will be the authoritative source. Once it is released, proper referencing will be available.

@edwardhartnett
Copy link
Collaborator Author

@bensonr scientific documentation of the algorithm is pretty different from code documentation.

Can we have the programmers document the code as well?

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

@edwardhartnett edwardhartnett

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bensonr @lgannoaa @edwardhartnett