Skip to main content

Calculate the entraining CAPE (ECAPE) of a parcel.

Project description

ecape

ecape is a simple module that contains an entraining CAPE, or ECAPE, calculation described by Peters et. al. 2023. Peters-provided MatLab scripts serve as a reference and test verification data. The module leans heavily on MetPy for meteorological calculations.

PyPI - Version PyPI - Python Version

Installation & Use

In console:

pip install ecape

See the example in linked documentation.

   from ecape.calc import calc_ecape
   ...
   ecape = calc_ecape(height, pressure, temperature, specific_humidity, u_wind, v_wind)

Documentation & Source

https://github.com/citylikeamradio/ecape

https://citylikeamradio.github.io/ecape

Contact

Questions, comments, and feedback are certainly welcome. This project is a personal exercise in learning how to publish packages to Github & PyPI, so excuse the excessive documentation for one function.

Future Work

  • add support for other water content variables
  • if useful, incorporate into MetPy
  • provide cli .nc, .csv, & aws support

A note on undiluted CAPE & calculation accuracy

If users prefer their own CAPE calculations, use the undiluted_cape parameter:

When comparing calc_ecape.py & COMPUTE_ECAPE.m run on Peters 2023 sample data, there is a ~10% difference in the resultant ECAPE. This is almost entirely due to a difference in calculated MUCAPE. The tests describe other sources of variation (~1%).

Given:

  • the methods here are within ~1% of Peters' calculations when undiluted CAPE is equivalent
  • Peters et. al. specifically mention MetPy for determining undiluted CAPE
  • MetPy is a reliable, open-source, and frequently used meteorological calculation package

MetPy's undiluted CAPE calculations were chosen for ease of readability and implementation.

References

Ryan M. May, Sean C. Arms, Patrick Marsh, Eric Bruning, John R. Leeman, Kevin Goebbert, Jonathan E. Thielen, Zachary S Bruick, and M. Drew. Camron. Metpy: a Python package for meteorological data. 2023. URL: Unidata/MetPy, doi:10.5065/D6WW7G29.

John Peters. ECAPE scripts. 2 2023. URL: https://figshare.com/articles/software/ECAPE_scripts/21859818, doi:10.6084/m9.figshare.21859818.v4.

Peters, J. M., D. R. Chavas, C. Su, H. Morrison, and B. E. Coffer, 2023: An analytic formula for entraining CAPE in mid-latitude storm environments. J. Atmos. Sci., https://doi.org/10.1175/JAS-D-23-0003.1, in press.

Licence

ecape is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecape-0.1.1.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

ecape-0.1.1-py3-none-any.whl (3.0 MB view details)

Uploaded Python 3

File details

Details for the file ecape-0.1.1.tar.gz.

File metadata

  • Download URL: ecape-0.1.1.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.0

File hashes

Hashes for ecape-0.1.1.tar.gz
Algorithm Hash digest
SHA256 df31ec798fe4b00bfcf1c3863f7f839775fafd6525147d21b641f55758aeb1b3
MD5 7b58875da78f3558788a9d50cb4a5891
BLAKE2b-256 f7b5dd1f806a1a0692fba7e693d916f0b298c79409c170b8025320d087ee497d

See more details on using hashes here.

File details

Details for the file ecape-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ecape-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.0

File hashes

Hashes for ecape-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4187dcbb31ab7dab2e0ff1ed56767fd1645b27cd7493f4187fe5205a05e73e2b
MD5 dda60b9115212675ca49356bfaddb5fa
BLAKE2b-256 158223c03914c1051d85afba23845d44cdb1b8cc959b61c238e5540bf89cd967

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page