xebadir commented 4 years ago

First commit - add Bunkers method for storm motion applied in both the PYF wrapper and .f90 file for model levels only. Do we need to duplicate this into the pressure version, or is this redundant?

codecov[bot] commented 4 years ago

Codecov Report

Merging #33 into master will increase coverage by 0.94%. The diff coverage is 33.33%.

@@            Coverage Diff             @@
##           master      #33      +/-   ##
==========================================
+ Coverage   66.07%   67.01%   +0.94%     
==========================================
  Files           7        9       +2     
  Lines         280      288       +8     
  Branches       76       76              
==========================================
+ Hits          185      193       +8     
  Misses         73       73              
  Partials       22       22

Impacted Files	Coverage Δ
src/xcape/__init__.py	`100.00% <ø> (ø)`
src/xcape/_version.py	`100.00% <ø> (ø)`
src/xcape/cape_numba.py	`50.00% <ø> (ø)`
src/xcape/core.py	`84.41% <ø> (ø)`
src/xcape/duck_array_ops.py	`79.31% <ø> (ø)`
src/xcape/srh.py	`93.33% <ø> (ø)`
src/xcape/stdheight.py	`62.50% <ø> (ø)`
src/xcape/xarray.py	`0.00% <ø> (ø)`
src/xcape/cape_fortran.py	`63.63% <33.33%> (ø)`
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ec5b6a7...4556110. Read the comment docs.

xebadir commented 4 years ago

Remaining tasks for documentation to be handled through this request: Determine whether to add documentation to both the ML and PL variants of the fortran codes. Clean up documentation for the SRH, CAPE and STDheight fortran components and their wrapper pyf files. Add documentation to cape_fortran.py, stdheight.py, duck_array_ops.py

chiaral commented 4 years ago

Remaining tasks for documentation to be handled through this request:

Determine whether to add documentation to both the ML and PL variants of the fortran codes.

I think we should have documentation on both ML and PL, and simply copy and paste the common part and change ML or PL wording where appropriate.

Clean up documentation for the SRH, CAPE and STDheight fortran components and their wrapper pyf files. Add documentation to cape_fortran.py, stdheight.py, duck_array_ops.py

Both these need to be done indeed. I would do it in another PR tho.

xgcm / xcape

Added initial documentation to describe the fortran calculations used by core.py #33

Codecov Report