FrameIt 1.0.0 documentation

What is FrameIt

• What is FrameIt

Getting started

• Installation of FrameIt
  • 1. Prerequisites
  • 2. Get the source code
  • 3. Create and activate the Python environment using a conda/mamba environment
  • 4. Install the FrameIt package
• FrameIt Quick Start
  • Prerequisites
  • Check that the CLI is available
  • Display environment information
  • Prepare the YAML configuration
  • Validate the configuration
  • Run FrameIt
  • NetCDF exports
  • Optional: HDF5 debug environment variable
  • Getting help for subcommands
  • Exit codes
  • Minimal HPC example (Slurm)

User guide

• Input files
• Configuration file (YAML)
  • General syntax
  • Simulation identification and input files
  • Debug flag
  • Minimal example
  • Tracking options
  • Requested variables (user)
  • Output directories
  • Polar projection diagnostics (optional)
  • Additional simulation parameters (optional)
  • Common pitfalls
• Output files
  • Naming convention
  • Produced files
  • Metadata and attributes
  • Compression and performance
  • NetCDF exports

Tracker

• Prescribed-track method
  • Purpose
  • Core assumptions
  • Input and output
  • Configuration keys
  • Practical considerations and limitations
• Pressure-wind tracker
  • Overview
  • Required input fields
  • Algorithm
  • Output
  • Window sizes and conversion from physical radii
  • Configuration and usage
  • Illustration
• Utrack (AI) tracker
  • Overview
  • Required input fields
  • Output
  • Configuration and usage
  • Dependencies
  • Model weights
• Fixed-box method
  • Overview
  • Inputs and outputs
  • Configuration
  • Algorithm
  • Practical considerations and limitations
  • Example
  • Illustration

Polar projection

• Polar projection with xESMF regridding
  • Polar projection using xESMF
  • Illustration

Visualization tools

• Rotate polar axes
  • Function setup_geodesic_polar_ax

Developper section

• How to add a new tracker
  • Overview of the tracker system
  • Step 1 — Create the tracker file
  • Step 2 — Register the tracker
  • Step 3 — Declare the required variables
  • Step 4 — Expose configuration parameters
  • Summary of files to modify