Skip to main content

rojak a package with a blend of features -- from turbulence diagnostics to aeroelasticity

Project description

rojak: A Library and CLI Tool for Aviation Turbulence Analysis

CI CD codecov

status DOI

python Checked with pyright Formatted with ruff Contributor Covenant

rojak is a distributed python library and command-line tool for using meterological data to forecast CAT and evaluating the effectiveness of CAT diagnostics against turbulence observations. Currently, it supports,

  1. Computing turbulence diagnostics on meteorological data from European Centre for Medium-Range Weather Forecasts's (ECMWF) ERA5 reanalysis on pressure levels. Moreover, it is easily extendable to support other types of meteorological data.
  2. Retrieving and processing turbulence observations from Aircraft Meteorological Data Relay (AMDAR) data archived at National Oceanic and Atmospheric Administration (NOAA) and AMDAR data collected via the Met Office MetDB system.
  3. Computing 27 different turbulence diagnostics, such as the three-dimensional frontogenesis equation, turbulence index 1 and 2, negative vorticity advection, and Brown's Richardson tendency equation.
  4. Converting turbulence diagnostic values into the eddy dissipation rate (EDR) --- the International Civil Aviation Organization's (ICAO) official metric for reporting turbulence.

[!NOTE] This repository is under active development. As a result,

  1. The API is subject to change and may not be stable
  2. The documentation is incomplete and will be updated as development progresses.

We appreciate your understanding and encourage you to check back for updates.

Rojak is also a salad with Javanese origins. Colloquially (in Singlish), it means a mixture of things. This package is for a traditionally unconventional mixture of aviation meteorology (turbulence diagnostics) and (coming soon) aeroelasticity.

What could I use rojak for?

If you're an aviation meteorologist, rojak can be used to computing the various turbulence diagnostics and converting it into EDR like this map from the Aviation Weather Center.

Or if you're a researcher and you'd like to understand how turbulence is impacted by climate change, rojak can be used to compute the probability of encountering turbulence and examining how that has changed over time.

Documentation

Learn more about rojak at imperialcollegelondon.github.io/rojak/.

Installation

For installation instructions, please see the Installation Guide.

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

rojak_cat-1.0.1.tar.gz (399.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rojak_cat-1.0.1-py3-none-any.whl (132.8 kB view details)

Uploaded Python 3

File details

Details for the file rojak_cat-1.0.1.tar.gz.

File metadata

  • Download URL: rojak_cat-1.0.1.tar.gz
  • Upload date:
  • Size: 399.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rojak_cat-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8a52cfe686e77aa6f9891325f222540bf03497334ea64876690f55d4fb0fffa6
MD5 b16cade70d1bd18a1ee1b734150b1852
BLAKE2b-256 3f84e91b1a3278334e97966d917ed2c496112a099e2feaaea6683f2a0da831b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for rojak_cat-1.0.1.tar.gz:

Publisher: release.yml on ImperialCollegeLondon/rojak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rojak_cat-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: rojak_cat-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 132.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rojak_cat-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b2973d89a9e2040a80b1f7f2cad610466923b372c4fcae3dce697a6bdc6c3fc8
MD5 d9baaa7c59c745a6b8c923c143911ebf
BLAKE2b-256 cf0547b7d934ca87d7106aea33391e88755fe2c4515f53ac106e1d353f00d701

See more details on using hashes here.

Provenance

The following attestation bundles were made for rojak_cat-1.0.1-py3-none-any.whl:

Publisher: release.yml on ImperialCollegeLondon/rojak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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