LorenzCycleToolkit

Welcome to the LorenzCycleToolkit documentation! This toolkit is designed to calculate the Lorenz Energy Cycle (LEC) for specific atmospheric regions.

Contents:

• Overview
  • What is the Lorenz Energy Cycle?
  • Mathematical Framework
  • Getting Started
• Installation
  • Prerequisites
  • Installation Methods
  • Troubleshooting
  • Next Steps
• Configuration
  • Namelist File
  • Box Limits File (Optional)
  • Track File (Optional)
  • Namelist for ERA5 Data (CDS API)
  • Next Steps
• Usage
  • Before You Start
  • Input Data Requirements
  • System Requirements and Performance
  • Fixed Framework
  • Moving Framework
  • Interactive Domain Selection
• Advanced Options
  • Custom Output Names
  • Using Pre-computed Vorticity
  • Working with MPAS-A Data
• Automatic ERA5 Data Download
• Flags
• Common Issues and Questions
• Examples and Tutorials
  • Tutorial 1: Basic Fixed Framework Analysis
  • Tutorial 2: Moving Framework with Track File
  • Tutorial 3: Downloading and Analyzing ERA5 Data
  • Tutorial 4: Interactive Domain Selection
  • Advanced Example: Batch Processing Multiple Cases
  • Next Steps
• CDS API - Complete Example
  • Step-by-Step Example
  • What Happens Behind the Scenes
  • Expected Output
  • Common Use Cases
  • Troubleshooting
  • Advanced: Custom Temporal Resolution
  • Notes and Limitations
• Results
  • Main Results File
  • Log File
• Troubleshooting and FAQ
  • Track File Issues
  • Units and Variable Specifications
  • Data Format and Loading Issues
  • Memory and Performance Issues
  • Configuration Issues
  • CDS API Issues
  • Still Having Issues?
• File Naming Convention
  • Input Files
  • Track Files
  • Box Limits Files
• Mathematics
• Contributing
• Support and Issue Reporting
  • Getting Support
  • Reporting Issues
• References
  • Citing LorenzCycleToolkit
  • Foundational Literature
• License