ATMOS-BUD

Contents:

  • Overview
    • Thermodynamic Equation
    • Vorticity Budget Equation
    • Water Budget Equation
  • Getting Started
    • Cloning the Repository
    • Creating a Conda Environment
    • Installing Dependencies
  • Downloading Data
    • Method 1: Copernicus Interface
    • Method 3: NCAR’s Research Data Archive
    • Method 3: Automated Download Using get_era5_data.py
  • Running the Program
    • Positional Arguments
    • Optional Arguments
    • Fixed Framework
    • Semi-Lagrangian Framework
      • Track File Format
      • Running the Program with the Semi-Lagrangian Framework
      • Output
      • Important Note on Track File Formatting
    • Interactive Framework
      • Running the Program with the Interactive Framework
        • Initial Data Subsetting
        • Domain Selection for Each Time Step
        • Output and Replicability
        • Leveraging the Interactive Framework
  • Fixed Framework Tutorial
    • Preparing Your Environment
      • 1. Activate the Conda Environment:
      • 2. Prepare Input Files:
    • Running ATMOS-BUD with the Fixed Framework
      • Main Execution
      • Example Terminal Output
      • Explanation of Key Terminal Outputs
    • Understanding the Output Files
      • Figures Directory:
      • NetCDF File:
      • CSV Files:
    • Visualizing Generated Data
      • Visualizing Vertical Profiles
      • Visualizing Hovmoller Diagrams
      • Spatial visualization of Budget Terms
    • Interpreting the Results
  • Track Framework Tutorial
    • Preparing Your Environment
      • 1. Activate the Conda Environment:
      • 2. Prepare Input Files:
    • Running ATMOS-BUD with the Track Framework
      • Example Terminal Output
      • Explanation of Key Terminal Outputs
    • Understanding the Output Files
      • Figures Directory:
      • NetCDF File:
      • Track File
      • CSV Files:
      • Log File
    • Visualizing Generated Data
  • Interactive Framework Tutorial
    • Preparing Your Environment
      • 1. Activate the Conda Environment:
      • 2. Prepare Input File:
    • Running ATMOS-BUD with the Interactive Framework
      • Selecting the Domain Interactively
      • Terminal Outputs and Generated Files
    • Visualizing Generated Data
  • Results and Output
    • Directory Structure and Contents
      • heat_terms/
      • moisture_terms/
      • vorticity_terms/
      • Figures/
        • Figures/boxes/
    • Track-Related Files (for track and choose frameworks)
    • Log File
    • Understanding the Output
  • API Reference
    • Data Handling Module
      • Main Functions
        • load_data()
        • preprocess_data()
      • Core Functions
        • Data Loading
        • Data Preprocessing
      • Key Features
        • Multi-Format Support
        • Coordinate Management
        • Data Optimization
        • Error Handling
      • Preprocessing Pipeline
      • Usage Examples
        • Basic Data Loading
        • GFS Multi-File Loading
        • Complete Preprocessing
        • Data Pipeline Integration
      • Supported Data Sources
    • Calculations Module
      • Main Functions
        • CalcZonalAverage()
        • CalcAreaAverage()
        • perform_calculations()
      • Core Functions
        • Statistical Operations
        • Main Workflow Function
      • Key Features
        • Zonal Averaging
        • Area Averaging
        • Budget Term Processing
        • Domain Handling
        • Time Series Processing
        • Output Generation
      • Usage Examples
        • Basic Usage
        • Area Averaging
      • Mathematical Background
    • Data Object Module
      • Main Classes
        • DataObject
      • DataObject Class
      • Key Features
      • Main Methods
        • Variable Processing
        • Budget Calculations
      • Data Structure
      • Usage Examples
    • Domain Selection Module
      • Main Functions
        • coordXform()
        • tellme()
        • fmt()
        • draw_box()
        • plot_zeta()
        • map_decorators()
        • plot_min_max_zeta()
        • initial_domain()
        • draw_box_map()
        • get_domain_limits()
      • Core Functions
        • Domain Definition
        • Interactive Domain Selection
        • Visualization Functions
        • Utility Functions
      • Key Features
        • Domain Selection Methods
        • Coordinate System Handling
        • Storm Center Detection
        • Interactive Interface
      • Domain Limit Dictionary Structure
      • Usage Examples
        • Fixed Domain Analysis
        • Storm Tracking Analysis
        • Interactive Domain Selection
        • Direct Interactive Functions
      • Configuration Files
        • Fixed Domain Configuration
        • Storm Track File Format
      • Integration with Analysis Workflow
    • Output Management Module
      • Main Functions
        • manage_output()
        • backup_file()
        • save_results_netcdf()
        • save_results_csv()
        • save_output_track()
      • Key Features
      • Output Formats
        • CSV Files
        • NetCDF Files
        • Directory Structure
      • Usage Examples
    • Visualization Module
      • Key Features
      • Dependencies
      • Functions Overview
        • Map Features and Setup
        • Domain and Track Visualization
        • Time Series Analysis
        • Hovmöller Diagrams
      • Integration Examples
        • Complete Visualization Workflow
        • Multi-Level Analysis Visualization
      • Technical Notes
        • Color Schemes
        • Figure Management
        • Data Requirements
        • Output Management
    • Utilities Module
      • Main Functions
        • initialize_logging()
        • convert_lon()
        • handle_track_file()
        • find_extremum_coordinates()
        • slice_domain()
        • get_domain_extreme_values()
      • Core Functions
        • Logging and Configuration
        • Data Preprocessing Utilities
        • Track File Management
        • Atmospheric Feature Detection
      • Key Features
        • Coordinate System Management
        • Logging System
        • Track Data Integration
        • Storm Analysis Tools
      • Usage Examples
        • Logging Setup
        • Coordinate Conversion
        • Domain Slicing
        • Track File Processing
        • Feature Detection
        • Complete Workflow Integration
      • Error Handling and Validation
    • Command Line Interface
      • Main Functions
        • parse_arguments()
      • Key Features
      • Command Structure
        • Basic Usage
        • Available Arguments
      • Configuration Files
        • YAML Configuration
      • Usage Examples
    • ERA5 Data Module
      • Key Features
      • Dependencies
      • Authentication Setup
      • Functions Overview
        • download_era5_data()
      • Data Request Configuration
        • Variable Selection
        • Pressure Level Configuration
        • Temporal Configuration
        • Spatial Domain Configuration
      • Integration Examples
        • Complete ERA5 Download Workflow
        • Multi-Case Download with Error Handling
        • Custom Variable Selection
      • Technical Notes
        • API Limitations
        • Error Handling
        • Performance Optimization
        • Data Quality
    • Core Modules
      • Data Handling
        • load_data()
        • preprocess_data()
      • Calculations
        • CalcZonalAverage()
        • CalcAreaAverage()
        • perform_calculations()
      • Data Object
        • DataObject
      • Domain Selection
        • coordXform()
        • tellme()
        • fmt()
        • draw_box()
        • plot_zeta()
        • map_decorators()
        • plot_min_max_zeta()
        • initial_domain()
        • draw_box_map()
        • get_domain_limits()
      • Output Management
        • manage_output()
        • backup_file()
        • save_results_netcdf()
        • save_results_csv()
        • save_output_track()
      • Visualization
        • map_features()
        • Brazil_states()
        • plot_fixed_domain()
        • plot_track()
        • plot_min_max_zeta_hgt()
        • hovmoller_mean_zeta()
      • Utilities
        • initialize_logging()
        • convert_lon()
        • handle_track_file()
        • find_extremum_coordinates()
        • slice_domain()
        • get_domain_extreme_values()
      • Command Line Interface
        • parse_arguments()
      • ERA5 Data Download
        • download_era5_data()
        • download_era5_data_legacy()
  • Contact and Support
  • License
ATMOS-BUD
  • Welcome to ATMOS-BUD’s documentation!
  • View page source

Welcome to ATMOS-BUD’s documentation!

Contents:

  • Overview
    • Thermodynamic Equation
    • Vorticity Budget Equation
    • Water Budget Equation
  • Getting Started
    • Cloning the Repository
    • Creating a Conda Environment
    • Installing Dependencies
  • Downloading Data
    • Method 1: Copernicus Interface
    • Method 3: NCAR’s Research Data Archive
    • Method 3: Automated Download Using get_era5_data.py
  • Running the Program
    • Positional Arguments
    • Optional Arguments
    • Fixed Framework
    • Semi-Lagrangian Framework
    • Interactive Framework
  • Fixed Framework Tutorial
    • Preparing Your Environment
    • Running ATMOS-BUD with the Fixed Framework
    • Understanding the Output Files
    • Visualizing Generated Data
    • Interpreting the Results
  • Track Framework Tutorial
    • Preparing Your Environment
    • Running ATMOS-BUD with the Track Framework
    • Understanding the Output Files
    • Visualizing Generated Data
  • Interactive Framework Tutorial
    • Preparing Your Environment
    • Running ATMOS-BUD with the Interactive Framework
    • Visualizing Generated Data
  • Results and Output
    • Directory Structure and Contents
    • Track-Related Files (for track and choose frameworks)
    • Log File
    • Understanding the Output
  • API Reference
    • Data Handling Module
    • Calculations Module
    • Data Object Module
    • Domain Selection Module
    • Output Management Module
    • Visualization Module
    • Utilities Module
    • Command Line Interface
    • ERA5 Data Module
    • Core Modules
  • Contact and Support
  • License

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025, Danilo Couto de Souza.

Built with Sphinx using a theme provided by Read the Docs.