CLI and Python API

This page lists the primary command-line tools and the top-level Python APIs exposed by this project.

Command-line tools

  • ismip7-antarctic-ocean-forcing — main workflow driver.

  • ismip7-antarctic-convert-cmip — convert CMIP thetao/so to ct/sa on the native grid.

  • ismip7-antarctic-remap-cmip — remap CMIP data to the ISMIP grid.

  • ismip7-antarctic-extrap-cmip — horizontally & vertically extrapolate remapped CMIP ct/sa.

  • ismip7-antarctic-remap-clim — remap observational climatology to the ISMIP grid.

  • ismip7-antarctic-extrap-clim — extrapolate remapped climatology (adds dummy time).

Each command supports --help for usage details. See the User Guide for end-to-end examples.

Python API (entry points)

  • i7aof.__main__.main — implementation behind ismip7-antarctic-ocean-forcing.

  • i7aof.convert.cmip.main — implementation behind ismip7-antarctic-convert-cmip.

  • i7aof.remap.cmip.main — implementation behind ismip7-antarctic-remap-cmip.

  • i7aof.extrap.cmip.main — implementation behind ismip7-antarctic-extrap-cmip.

  • i7aof.remap.clim.main — implementation behind ismip7-antarctic-remap-clim.

  • i7aof.extrap.clim.main — implementation behind ismip7-antarctic-extrap-clim.

Non-public internals

Helper modules i7aof.remap.shared and i7aof.extrap.shared provide the factored logic reused by CMIP and climatology workflows. They are not considered public API; do not import them directly in external scripts.

All public modules are covered in the autogenerated API docs except the internal shared helpers noted above. When proposing new CLI entry points add both: (1) the console script entry in pyproject.toml and (2) an item in this document plus the relevant user guide page.