AFIM Python Package Documentation

AFIM (Antarctic Fast Ice and Pack Ice Metrics) is a Python library to analyse and visualise CICE model output, focused on sea ice processes.

• API Reference
  • sea_ice_toolbox
  • sea_ice_gridwork
  • sea_ice_classification
  • sea_ice_observations
  • sea_ice_metrics
  • sea_ice_plotter
  • sea_ice_regridder
  • sea_ice_icebergs
  • sea_ice_ACCESS
• AFIM Sea Ice Toolbox: sea_ice_config.json reference
  • Conventions used in this document
  • Top-level (non-dictionary) keys
  • Dictionary keys (modules and their config blocks)
  • Practical validation checklist

AFIM Scientific Studies

AFIM studies

• AFIM Sensitivity Study
  • 0. Model Configuration & Setup
  • Fast-ice classification (sea_ice_classification.py)
  • 2. Fast‑ice metrics (SeaIceMetrics)
  • 3. Recommended reporting for publications
  • 4. Thresholds
• Free-slip Boundary Condition in CICE6 (AFIM / CICE_free-slip)
  • Contents
  • 1. Purpose and scope
  • 2. Background: why free-slip matters
  • 3. ice_in configuration
  • 4. Code changes and control flow
  • 5. Free-slip strain-rate discretisation
  • 6. Interaction with Lateral Drag Parameterisation (LDP)
  • 7. Deriving and interpreting \(C_s\)
  • 8. Resolution dependence and tuning behaviour: why \(C_s\) can vary by 10–1000×
  • 9. Mixed-layer depth in standalone CICE
  • 10. Practical tuning for the residual velocity
  • 10. Verification checklist
  • 11. Caveats and known limitations
  • 12. References
• Lateral Drag Form Factor Creation
  • 1. Definitions and target quantities
  • 2. Required grid geometry (CICE C-grid file)
  • 3. Coastline ingestion and conditioning (high-res polygon shapefile)
  • 4. Segment geometry on the sphere (WGS84 geodesic)
  • 5. Assigning segments to model cells (projected KDTree)
  • 6. Local-angle transform and accumulation
  • 7. Grounded-iceberg (GI) contributions from a polygon GeoPackage
  • 8. Combined coast + GI form factors and NetCDF outputs
  • 9. Practical interpretation