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 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.0.tar.gz (331.9 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.0-py3-none-any.whl (115.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rojak_cat-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8f02c02841635a98b261f764d08586a80b1b90e57d87fc140e1023b736452689
MD5 4494732b79dc5310fbcfd955ac07398c
BLAKE2b-256 f39dfc9e54cf5f526f4b7ca87f3839721f251530fbde5e3f7b7f458be658ff25

See more details on using hashes here.

Provenance

The following attestation bundles were made for rojak_cat-1.0.0.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.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for rojak_cat-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ebaccf8fec8b456c562072e3a1699a262797cc6227ceeb412dd46e3c8f74f11c
MD5 dabd8e89b05312349298112179c78129
BLAKE2b-256 6772b927795eb7443ece8051955b20a3f340eb3b80408ec72b60fa77c381e63d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rojak_cat-1.0.0-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