CliMA
Adding 1D Column Examples to Improve Documentation
Hello,
I recently came across this project and noticed that docs/src/examples.md might benefit from some 1D Column examples. I wanted to check whether you would like to have documented. or not
If this contribution would be helpful, I’d be happy to work on it!
Please let me know if you have any specific guidelines or preferred formats for the examples.
I noticed the same thing and would also like to help add some more examples to the markdown file.
Hi,
Following up on my initial suggestion about adding 1D Column examples, I plan to contribute documentation of the existing examples specifically covering the following areas:
- 1D Hydrostatic Balance Example [hydrostatic.jl] : Setting up a simple hydrostatic equilibrium test. Demonstrating initialization of the atmosphere using the existing decaying temperature profile.
- 1D Ekman Layer Example [ekman.jl] : A simplified scenario that clearly demonstrates Ekman spiral formation under basic atmospheric boundary conditions.
Perhaps we can discuss what types of examples would be fruitful? Or, other parts of ClimaCore whose documentation could be improved? I would really like to see improvements to the documentation of our Geometry module.
Sure, I'd be happy to discuss improving other parts of the documentation. For the geometry module, were you thinking of adding examples to the documentation? Or maybe including the functionality of parts of the module not mentioned in the documentation?
Hi @charleskawczynski
I opened the issue #2255 , which also contributes to the documentation with a new example. Do you think that is a appropriate one? Thanks!
Hi @yiyuef, yes, I think having a 1D and 2D example would be useful, but I think that adding documentation for the geometry module would involve much less overlap, and I would encourage a 1D/2D example + documentation of the Geometry module.
For the geometry module, were you thinking of adding examples to the documentation? Or maybe including the functionality of parts of the module not mentioned in the documentation?
Yes, examples, making figures / images showing how points are expressed on a space, functionality, and doc strings for things like subtypes of Geometry.AbstractPoint.
I started trying to document the Geometry module in https://github.com/CliMA/ClimaCore.jl/pull/988/files, but it relied on many other parts of the codebase, and I felt that the scope of the documentation required too much of the codebase to better understand the scope of the Geometry module itself.
It would be nice if we could visually document what each of our AxisTensors represent, and how they are transformed between one another. This shouldn't actually need things like a space, but might require using Makie.jl for creating visualizations on a sphere, for example.
Hi @charleskawczynski
Thanks for your note, and this visualization work looks interesting. Would you mind explain a little bit more about how AxisTensor works? Thanks!
Hi @charleskawczynski, just following up on the now closed issue #2241 regarding adding the 1D Burgers' example and documentation. I see that you have mentioned in this thread adding documentation for the Geometry module, specifically documentation for the AxisTensor visual representations. I would like to move forward with one of these options. Is there a preferred implementation? I'm excited to get started on a contribution.
I have a full plate, but @Sbozzolo or @dennisYatunin will be able to help you with this.