User Guide

This guide covers configuration and common tasks for using i7aof to generate forcing datasets. For installation, see Getting Started.

Contents

• Installation
• Quickstart
  • Prerequisites
  • 60‑second smoke check
  • Run your first model (simplest path)
  • Where next
• End‑to‑End Workflows
  • Final published outputs (for ice‑sheet modelers)
  • Workflow overview (compact)
  • Step Details
  • Configuration Skeleton
  • Troubleshooting Quickies
  • Programmatic Example
• IMBIE Polygon Export
  • Recommended command
  • Inputs and outputs
  • Debug outputs
  • Notes on topology behavior
• Climatology Workflows
  • Source
  • Supported Climatologies (prefer v2: 06_nov)
  • Remap (Step 3a)
  • Extrapolate + Resample (Step 4a)
  • Thermal Forcing (Step 6b)
  • Back‑convert to thetao/so (Step 8b)
  • Configuration Keys
  • Notes and Tips
  • Python API
• CMIP Model Inputs
  • Scope & Role
  • Required Inputs & Minimum Coverage
  • Scenario Handling & Bias Correction Interaction
  • Directory & Naming Conventions (CMIP portion)
  • Configuration Blocks & Tuning
  • Performance Considerations
  • Validation Checklist
  • Common Pitfalls
  • Minimal Programmatic Snippet (CMIP portion only)
  • References
  • Next Steps
• Conversion
  • 1) thetao/so → ct/sa (TEOS‑10)
  • 2) ct/sa → TF (thermal forcing)
  • 3) ct/sa → thetao/so (back‑conversion)
• Remapping
  • What is remapped and when
  • ISMIP grid definitions
  • Methods and when to use them
  • Vertical preparation (to z_extrap)
  • Configuration keys
  • Outputs
  • Validation checklist
  • Tips
• Extrapolation
  • What gets extrapolated
  • Algorithm overview
  • Configuration keys
  • Outputs
  • Validation checklist
  • Common pitfalls
  • Minimal examples
• Bias Correction
  • Key behavior (classic)
  • CLI
  • Algorithm (classic)
  • Configuration
  • Python API
• Annual Averages (CMIP)
  • What is averaged
  • Weighting and calendars
  • Outputs
  • Validation checklist
  • Minimal example
• FAQ
  • Where do outputs go?
  • Do I need to download data manually?
  • Can I write compressed NetCDF output?