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

Update documentation #81

Merged
merged 1 commit into from
Jan 13, 2023
Merged

Update documentation #81

merged 1 commit into from
Jan 13, 2023

Conversation

akshaysridhar
Copy link
Member

@akshaysridhar akshaysridhar commented Jan 12, 2023 •
edited
Loading

Purpose

Update documentation (linked issue #24 )

Content

  • Overview documentation for equations being solved in SurfaceFluxes.jl through application of the Monin-Obukhov Similarity theory.
  • I have read and checked the items on the review checklist.

@codecov
Copy link

codecov bot commented Jan 12, 2023 •
edited
Loading

Codecov Report

Base: 81.90% // Head: 81.90% // No change to project coverage 👍

Coverage data is based on head (2c13bbe) compared to base (b70ad11).
Patch has no changes to coverable lines.

❗ Current head 2c13bbe differs from pull request most recent head 18f6072. Consider uploading reports for the commit 18f6072 to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   81.90%   81.90%           
=======================================
  Files           3        3           
  Lines         525      525           
=======================================
  Hits          430      430           
  Misses         95       95

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@akshaysridhar
Update Docs
df88893 
modified:   src/SurfaceFluxes.md
szy21
szy21 approved these changes Jan 13, 2023
View reviewed changes
Copy link
Member

@szy21 szy21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be directly copied from the design doc? I'm ok with merging it in. We may want to further clean up the design doc in the future, and can update the docs here accordingly.

@akshaysridhar
Copy link
Member Author

akshaysridhar commented Jan 13, 2023 •
edited
Loading

This seems to be directly copied from the design doc? I'm ok with merging it in. We may want to further clean up the design doc in the future, and can update the docs here accordingly.

Yeah for now they are a just ported summary of the equations in our code. The next step is to add more specific docs related to the obukhov_length and surface_conditions functions. (Mostly I want the tolerances and default settings to be obvious from the documentation). We also added some notes to the design docs related to roughness sublayer models - they will also be moved here to the docs pages for equations.

@akshaysridhar
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 13, 2023

Build succeeded:

@bors bors bot merged commit 48b25f1 into main Jan 13, 2023
@bors bors bot deleted the as/documentation1 branch January 13, 2023 01:12
@akshaysridhar akshaysridhar mentioned this pull request Jan 13, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szy21 szy21 szy21 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@akshaysridhar @szy21