MetPy icon indicating copy to clipboard operation
MetPy copied to clipboard

More examples in the documentation

Open Kyl67899 opened this issue 4 years ago • 5 comments

Give examples of each calculation and examples on the pages

Kyl67899 avatar Dec 28 '21 03:12 Kyl67899

I'm assuming you mean inline in the docstring? Or more coverage in our examples? Both?

Happy to, it's just a resource issue. We'd love to have more contributions from our community along these lines.

dopplershift avatar Jan 04 '22 22:01 dopplershift

I agree this would be a good thing to add!

I worked through the dry thermo stuff that didn't already have examples and that I had some intuition for what would be reasonable values (this excluded the sigma to pressure function since I don't really work with sigma levels).

Let me know how to go about adding them to the docs! I will endeavor to continue progressing through the moist thermo and other computations as time allows

jsillin avatar Feb 10 '22 12:02 jsillin

Hey, this looks like something I could help with. It is my first time contributing, so some direction on where exactly I would be needed would make the process a bit easier. Excited to help out!

jbsparo avatar Mar 17 '22 15:03 jbsparo

Welcome @jbsparo! In general this means adding one or more additional scripts within the examples/ directory, demonstrating the use of some pieces of functionality in an authentic fashion.

The examples are then automatically linked on the pages for the relevant functions/classes in the reference guide. For example, see here.

dopplershift avatar Mar 17 '22 17:03 dopplershift

Perfect, I'll get started on it.

jbsparo avatar Mar 18 '22 15:03 jbsparo