Skip to content

Add documentation for 1D Column Hydrostatic Balance and Ekman Layer examplesExpdoc#2325

Open
Snowdog85123 wants to merge 1 commit intoCliMA:mainfrom
Snowdog85123:expdoc
Open

Add documentation for 1D Column Hydrostatic Balance and Ekman Layer examplesExpdoc#2325
Snowdog85123 wants to merge 1 commit intoCliMA:mainfrom
Snowdog85123:expdoc

Conversation

@Snowdog85123
Copy link
Copy Markdown

They complement the existing 1D column examples and provide more atmospheric physics use cases.

This new PR replaces the previous one and includes only the intended changes.

  • Code follows the style guidelines OR N/A.
  • Unit tests are included OR N/A.
  • Code is exercised in an integration test OR N/A.
  • Documentation has been added/updated OR N/A.

Comment thread docs/src/examples.md
@Snowdog85123
Copy link
Copy Markdown
Author

@valeriabarra I've reordered the examples and removed the root-level file as requested. Please let me know if anything else needs adjustment.

Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
@Snowdog85123
Copy link
Copy Markdown
Author

screenshot of the rendered built docs:
截屏2025-05-15 21 26 47
截屏2025-05-15 21 27 32
截屏2025-05-15 21 27 22
截屏2025-05-15 21 27 10
截屏2025-05-15 21 26 59

Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
Comment thread docs/src/examples.md Outdated
@Snowdog85123
Copy link
Copy Markdown
Author

Hi @valeriabarra , I just modified as you suggested.
截屏2025-05-17 15 21 26
截屏2025-05-17 15 21 59

Comment thread docs/src/examples.md Outdated
@valeriabarra valeriabarra added the documentation Improvements or additions to documentation label May 20, 2025
@Snowdog85123
Copy link
Copy Markdown
Author

Thanks, I've applied the suggested change.

@valeriabarra
Copy link
Copy Markdown
Member

This branch looks good to me now.

@Snowdog85123 , please update it with current main by rebasing your branch on top of main. You can achieve this by:

  1. git checkout main
  2. git pull
  3. git checkout your_branch_name
  4. git rebase main your_branch_name

After these steps, you can please reduce the number of commits by using the fixup option in git rebase -i.
You can then proceed to force-push your branch via git push -f origin your_branch_name.

Once you are done, please let me know.

…xamples

Hello,
following up on the idea I previously shared in the issue, I've added documentation [docs/src/examples.md](https://github.com/CliMA/ClimaCore.jl/blob/main/docs/src/examples.md) for the two 1D column examples: the hydrostatic balance and the Ekman layer.

Please let me know if this contribution aligns with your goals for the documentation or if any revisions are needed. I'd be happy to make changes!
@valeriabarra
Copy link
Copy Markdown
Member

Hi @charleskawczynski , this PR is ready to be merged in. Buildkite needs to be enabled. Thank you!

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

Successfully merging this pull request may close these issues.

3 participants