VORTEX FRAMEWORK
Complete Documentation

Multi-Parameter Assessment Protocol for Tropical Cyclone Rapid Intensification

Python 3.8+ Version 0.2.0 MIT License Active Development

Documentation Index

Project Overview

Vortex Framework is a Multi-Parameter Assessment Protocol for Tropical Cyclone Rapid Intensification (RI) prediction. This comprehensive computational framework integrates 8 critical meteorological and oceanographic parameters to provide accurate forecasts of tropical cyclone intensification.

8-Parameter Framework

Comprehensive assessment combining ocean, atmospheric, and structural factors for RI prediction.

Real-time Forecasting

Enhanced time-stepping algorithms provide rapid intensity forecasts up to 24 hours.

Multi-Basin Support

Supports Atlantic, Pacific, and Indian Ocean basins with validated methodologies.

Key Features

Official Resources

Installation

Complete installation guide for all platforms

System Requirements

Quick Installation

From PyPI (Recommended)
pip install vortex-by-gitdeeper
From Source (Development)
git clone https://gitlab.com/gitdeeper3/vortex.git cd vortex pip install -e .

Platform-Specific Instructions

Termux/Android

# Update packages pkg update && pkg upgrade # Install Python and dependencies pkg install python python-pip git # Install core dependencies pip install numpy pyyaml # Clone and install vortex git clone https://gitlab.com/gitdeeper3/vortex.git cd vortex pip install -e .

Linux/Ubuntu

# Install prerequisites sudo apt-get update sudo apt-get install python3 python3-pip git # Install vortex git clone https://gitlab.com/gitdeeper3/vortex.git cd vortex pip3 install -e .

macOS

# Install Homebrew if not present /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" # Install Python brew install python3 git # Install vortex git clone https://gitlab.com/gitdeeper3/vortex.git cd vortex pip3 install -e .

Windows

# Install Python from python.org or Microsoft Store # Clone repository git clone https://gitlab.com/gitdeeper3/vortex.git cd vortex # Install pip install -e .

Verification

Test your installation:
# Test import python -c "import vortex; print('✅ Vortex installed successfully')" # Run test suite python run_tests.py # Expected output: ✅ 14/14 tests passed

Quick Start

Get up and running in minutes

Basic Usage Example

from src.algorithms.time_stepping import TimeStepper from src.core.vortex_engine import VortexEngine # Initialize engine for Atlantic basin engine = VortexEngine(basin="atlantic") # Create forecaster forecaster = TimeStepper() # Generate forecast forecast = forecaster.forecast_intensity( initial_intensity_kt=75.0, mpi_trajectory=[80.0, 85.0, 90.0, 95.0], environmental_trends={ "vws": [12.0, 10.0, 8.0, 6.0], "sst": [28.5, 28.8, 29.0, 29.2] }, time_horizon_hours=24 ) # Display results print(f"RI Probability: {forecast['ri_probability_time_series'][-1]:.1%}")

Advanced Example

from vortex.core.vortex_engine import VortexEngine from vortex.algorithms.time_stepping import EnhancedTimeSteppingForecast # Initialize with custom configuration engine = VortexEngine( basin="atlantic", config_file="config/custom_config.yaml" ) # Initialize enhanced forecaster forecaster = EnhancedTimeSteppingForecast() # Generate detailed forecast forecast = forecaster.forecast_intensity( initial_intensity_kt=75.0, mpi_trajectory=[80.0, 85.0, 90.0, 95.0], environmental_trends={ "vws": [12.0, 10.0, 8.0, 6.0], "sst": [28.5, 28.8, 29.0, 29.2], "rh_mid": [65.0, 68.0, 70.0, 72.0], "ohc": [55.0, 60.0, 65.0, 70.0] }, time_horizon_hours=24, ensemble_members=20 ) # Access detailed results print(f"RI Probability: {forecast['ri_probability_time_series'][-1]:.1%}") print(f"Forecast Intensity: {forecast['intensity_forecast'][-1]:.1f} kt") print(f"Confidence: {forecast['confidence_interval']}")

The 8-Parameter Framework

Core physical parameters driving Rapid Intensification in tropical cyclones

# Parameter Symbol Description Role in RI
1 Ocean Heat Content OHC Thermal energy in upper ocean layers Primary energy source
2 Eyewall Symmetry σ_sym Structural organization index Indicates mature structure
3 Vertical Wind Shear VWS 850-200 hPa wind difference Major inhibiting factor
4 Mid-Level Humidity RH_mid 700-500 hPa relative humidity Supports convection
5 Low-Level Vorticity ζ_850 850 hPa relative vorticity Initial spin-up indicator
6 Convective Organization Org_conv Inner-core convection coherence Latent heat release efficiency
7 Outflow Efficiency Eff_outflow Upper-level ventilation capacity Removes rising air mass
8 Intensity Trend ΔInt_trend 6-12h intensity change patterns Recent momentum indicator

Parameter Thresholds for RI Favorable Conditions

FAVORABLE_CONDITIONS = { "OHC": ">50 kJ/cm²", "VWS": "<10 kt", "RH_mid": ">60%", "ζ_850": ">1.5×10⁻⁵ s⁻¹", "σ_sym": ">0.7", "Org_conv": ">0.6", "Eff_outflow": ">0.5", "ΔInt_trend": "positive" }

Architecture

Modular and extensible framework design

Project Structure

vortex/ ├── src/ # Source code │ ├── algorithms/ # Numerical methods │ ├── core/ # Core engine │ ├── data/ # Data handling │ └── utils/ # Utilities ├── data/ # Data directory ├── config/ # Configuration files ├── tests/ # Test suite ├── reports/ # Generated reports ├── examples/ # Usage examples └── docs/ # Documentation

Core Components

VortexEngine

Main forecasting engine that coordinates all components and manages basin-specific configurations.

Time-Stepping Algorithms

Advanced numerical methods for intensity forecasting with ensemble capabilities.

Data Loader

Handles input data processing, validation, and formatting for forecast generation.

Report Generator

Automated creation of comprehensive forecast reports with visualizations.

Algorithms

Available numerical methods and forecasting techniques

Key Algorithms

Algorithm Selection Guide

Standard Time-Stepping

Best for: Operational forecasting, real-time applications, single deterministic forecast

from src.algorithms.time_stepping import TimeStepper

Enhanced Time-Stepping

Best for: Research applications, ensemble forecasting, uncertainty quantification

from vortex.algorithms.time_stepping import EnhancedTimeSteppingForecast

API Reference

Complete API documentation for all modules

vortex.core.vortex_engine

Main forecasting engine

class VortexEngine: """ Main forecasting engine for tropical cyclone RI prediction Args: basin (str): Ocean basin ('atlantic', 'pacific', 'indian') config_file (str, optional): Path to configuration file """ def __init__(self, basin, config_file=None): pass def forecast(self, **kwargs): """Generate RI forecast""" pass

vortex.algorithms.time_stepping

Time-stepping forecast algorithms

class EnhancedTimeSteppingForecast: """ Enhanced time-stepping forecaster with ensemble capabilities """ def forecast_intensity( self, initial_intensity_kt, mpi_trajectory, environmental_trends, time_horizon_hours, ensemble_members=1 ): """ Generate intensity forecast Returns: dict: Forecast results with RI probabilities """ pass

Frequently Asked Questions

What is Rapid Intensification (RI)?

RI is defined as an increase of maximum sustained wind speed ≥30 kt (≥55 km/h) in 24 hours. This phenomenon is one of the most challenging aspects of tropical cyclone forecasting.

Which basins are supported?

Currently supports Atlantic, Eastern Pacific, Western Pacific, and North Indian Ocean basins with validated methodologies for each region.

What data sources are required?

SST data, atmospheric reanalysis (wind shear, humidity), satellite-derived parameters for eyewall structure, and ocean heat content measurements.

Can I use this for real-time operations?

Yes, the framework is designed for operational use with real-time data inputs. It provides forecasts within seconds, making it suitable for operational centers.

Troubleshooting

ImportError: No module named 'vortex'

# Solution: Reinstall in development mode cd /path/to/vortex pip install -e .

NumPy compatibility errors

# Solution: Update NumPy pip install --upgrade numpy>=1.21.0

Report generation failures

# Solution: Check permissions and disk space ls -la reports/ df -h

Glossary

OHC (Ocean Heat Content)

Thermal energy in the upper ocean layers, critical for cyclone intensification. Measured in kJ/cm².

VWS (Vertical Wind Shear)

850-200 hPa wind difference. Strong shear (>15 kt) inhibits development by disrupting storm structure.

MPI (Maximum Potential Intensity)

Theoretical maximum intensity based on environmental conditions, primarily SST and atmospheric stability.

Eyewall Symmetry (σ_sym)

Measure of structural organization. Higher values (>0.7) indicate favorable conditions for intensification.

RI Probability

Likelihood of rapid intensification occurrence in the forecast period, expressed as percentage.

Time-stepping

Numerical method advancing forecasts in discrete time intervals, accounting for environmental evolution.

Citation & Academic Use

How to Cite

If you use Vortex in your research, please cite:

BibTeX Format

@software{vortex_framework_2026, author = {Baladi, Samir}, title = {Vortex Multi-Parameter Assessment Protocol for Tropical Cyclone Rapid Intensification}, year = {2026}, publisher = {GitLab}, version = {0.2.0}, url = {https://gitlab.com/gitdeeper3/vortex}, doi = {10.5281/zenodo.xxxxxxx} }

PyPI Citation

@software{vortex_pypi_2026, author = {Baladi, Samir}, title = {vortex-by-gitdeeper: Python package for tropical cyclone RI forecasting}, year = {2026}, publisher = {PyPI}, url = {https://pypi.org/project/vortex-by-gitdeeper/}, version = {0.2.0} }

Author & Contact

Samir Baladi

Interdisciplinary AI Researcher, Scientific Software Developer

Contact Information

Research Interests

  • Applied AI/ML in geosciences
  • Computational meteorology
  • Scientific software development
  • Tropical cyclone dynamics
Open Science Principles
  • Source code publicly available under MIT License
  • Research methodologies transparently documented
  • Peer review and community feedback welcome
  • Active maintenance and support
Community Engagement
  • Open to collaborations and partnerships
  • Regular updates and improvements
  • Responsive to issues and feature requests
  • Committed to scientific excellence

Support & Help

Getting Help

  1. Check the FAQ for common questions
  2. Search existing issues
  3. Review Troubleshooting Guide
  4. Open a new issue with detailed information

Issue Reporting

When reporting issues, include:

  • Vortex version
  • Python version
  • Operating system
  • Complete error messages
  • Steps to reproduce