Skip to content

add 2D calculation examples#2628

Merged
dopplershift merged 3 commits intoUnidata:mainfrom
kgoebber:example_calcs_2D
Sep 19, 2022
Merged

add 2D calculation examples#2628
dopplershift merged 3 commits intoUnidata:mainfrom
kgoebber:example_calcs_2D

Conversation

@kgoebber
Copy link
Copy Markdown
Collaborator

Description Of Changes

This PR adds example calculations using fake data, which has been added to the cbook as a function. This was done to reduce the amount of code needed for each calculation to define the same data and put into an xarray format.

Examples included are:

  • Vorticity
  • Absolute Vorticity
  • Shearing Deformation
  • Stretching Deformation
  • Total Deformation
  • Divergence
  • Wind Speed
  • Advection
  • Q-Vector

Checklist

@kgoebber kgoebber requested a review from a team as a code owner August 21, 2022 21:11
@kgoebber kgoebber requested review from dopplershift and removed request for a team August 21, 2022 21:11
Copy link
Copy Markdown
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

Just a few minor copy edits.

This will really help improve our documentation and show how we intend for people to use the calculations.

Comment thread src/metpy/cbook.py Outdated
Comment thread examples/calculations/Advection.py Outdated
Comment thread examples/calculations/QVector.py Outdated
Comment thread examples/calculations/Advection.py Outdated
Comment thread examples/calculations/Vorticity.py Outdated
@dopplershift dopplershift added Type: Feature New functionality Area: Examples Affects examples labels Sep 15, 2022
@dopplershift dopplershift added this to the September 2022 milestone Sep 15, 2022
Copy link
Copy Markdown
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

Sorry, found one last thing.

Comment thread examples/calculations/QVector.py Outdated
@dopplershift dopplershift merged commit d279670 into Unidata:main Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Examples Affects examples Type: Feature New functionality

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

More examples in the documentation

2 participants