Welcome to jsmetrics’ documentation!

jsmetrics is an open-source Python package containing implementations of various statistics and algorithms which have been developed to identify or characterise jet streams.

The package is built on top of *xarray* and currently contains 17 methods, consisting of jet statistics, waviness metrics and jet core algorithms (described here). As this is an ongoing project, we are always in the process of finding and implementing new methods. You can find a full list of methods and their current progress state here

Note

• preprint now available on EGUsphere

• example jupyter notebooks on Github

Jet stream metrics

Statistic/Algorithm	Status		Statistic/Algorithm	Status
Gallego et al. 2005	To start		Strong & Davis 2005	To start
Koch et al. 2006	Complete		Archer & Caldiera 2008	Complete
Schiemann et al. 2009	Complete		Woollings et al. 2010	Complete
Manney et al. 2011	To verify		Allen et al. 2012	To start
Barnes & Polvani 2013	Complete		Pena-Ortiz et al. 2013	To verify
Screen & Simmonds 2013	In progress*		Grise & Polvani 2014	Complete
Kuang et al. 2014	To verify		Barnes & Polvani 2015	Complete
Francis & Vavrus 2015	Complete		Cattiaux et al. 2016	To verify
Barnes & Simpson 2017	Complete		Chenoli et al. 2017	In progress
Bracegirdle et al. 2018	Complete		Ceppi et al. 2018	Complete
Rikus 2018	In progress		Zappa et al. 2018	Complete
Kerr et al. 2020	To verify		Maher et al. 2020	To start
Bosiger et al. 2022	To start		Local Wave Activity	In progress*

* == help needed

For details of each ‘Complete’ or ‘In progress’ metric and algorithm, see our specification file. We track the progress of each method using a GitHub Kanban, and you can see their status.

Table of Contents:

• Installation
  • Stable release
  • From sources
• Why jsmetrics?
  • Quick start
  • What are jet streams?
  • The philosophy of jsmetrics
  • Disclaimer
• Examples of Use
  • 1. Using the jet statistics
  • 2. Using the jet core algorithms
  • 3. Using the waviness metrics
  • 4. Renaming data coords
  • 5. Merging data
  • 6. Running the jsmetrics in batch
• Statistics & Algorithms
  • Jet statistics
  • Jet core algorithms
  • Waviness metrics
• API reference
  • Metric sub-components
  • Utility functions
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Deploying
• Authors
  • Development Lead
  • Contributors
• History
  • 0.2.3-alpha (2024-04-08)
  • 0.2.2 (2024-03-15)
  • 0.2.2-beta (2024-03-13)
  • 0.2.1 (2023-12-01)
  • 0.2.0 (2023-10-12)
  • 0.1.7 (2023-10-10)
  • 0.1.7-beta (2023-10-05)
  • 0.1.7-alpha (2023-09-19)
  • 0.1.6 (2023-09-14)
  • 0.1.6-alpha (2023-08-19)
  • 0.1.5-beta (2023-08-16)
  • 0.1.5-alpha (2023-08-15)
  • 0.1.4 (2023-08-02)
  • 0.1.4-alpha (2023-07-21)
  • 0.1.3 (2023-07-07)
  • 0.1.2 (2023-06-06)
  • 0.1.2-alpha (2023-05-27)
  • 0.1.1 (2023-05-26)
  • 0.1.1-beta (2023-04-07)
  • 0.1.1-alpha (2023-03-31)
  • 0.1.0 (2023-01-22)
  • 0.0.19-alpha (2022-12-21)
  • 0.0.18 (2022-11-23)
  • 0.0.17 (2022-11-13)
  • 0.0.16 (2022-11-09)
  • 0.0.15 (2022-11-09)
  • 0.0.14 (2022-11-09)
  • 0.0.14-alpha (2022-10-25)
  • 0.0.13 (2022-10-19)
  • 0.0.12 (2022-10-19)
  • 0.0.12-alpha (2022-10-18)
  • 0.0.11 (2022-09-15)
  • 0.0.10 (2022-08-21)
  • 0.0.9 (2022-08-16)
  • 0.0.8 (2022-07-18)
  • 0.0.7-beta (2022-06-30)
  • 0.0.7-alpha (2022-06-10)
  • 0.0.6 (2022-06-09)
  • 0.0.6-beta (2022-05-31)
  • 0.0.6-alpha (2022-05-25)
  • 0.0.5 (2022-05-23)
  • 0.0.5-beta (2022-05-03)
  • 0.0.5-alpha (2022-04-24)
  • 0.0.4-beta (2022-02-09)
  • 0.0.4-alpha (2022-01-26)
  • 0.0.3-gamma (2022-01-14)
  • 0.0.3-beta (2022-01-14)
  • 0.0.3-alpha (2022-01-14)
  • 0.0.2 (2022-01-10)
  • 0.0.2-beta (2022-01-10)
  • 0.0.2-alpha (2022-01-04)
  • 0.0.1 (2022-01-04)
  • 0.0.1-beta (2021-12-30)