FESOMP Documentation

FESOMP is a modern Python library for working with FESOM2 (Finite Element Sea ice-Ocean Model) unstructured mesh data.

Getting Started

• Installation
  • From PyPI
  • From Source
  • Dependencies
  • Requirements
• Quick Start
  • Loading a Mesh
  • Plotting 2D Data
  • Vertical Transects
  • Interpolation to Regular Grid
  • Spatial Queries
  • Diagnostics
  • Next Steps

User Guide

• Working with Meshes
  • Loading Meshes
  • Mesh Properties
  • Topology (Lazy)
  • Geometry (Lazy)
  • Spatial Queries
  • Automatic Data Location Detection
  • Coordinate Transformations
• Plotting
  • 2D Map Plots
  • Regridding to Regular Grids
• Vertical Transects
  • Basic Transect
  • Customizing Transects
  • Automatic Detection
  • Advanced Usage
  • Great Circle Calculations
• Diagnostics
  • Sea Ice Diagnostics
  • Vertical Diagnostics
  • Mixed Layer
  • Meridional Overturning Circulation
  • Utility Functions

API Reference

• fesomp
  • Mesh
  • load_mesh()
  • plot()
  • regrid()
  • RegridInterpolator
  • transect()
  • interpolate_transect()
  • plot_transect()
  • TransectInterpolator
  • great_circle_path()
  • great_circle_distance()
  • Top-level Functions
  • Classes
• fesomp.mesh
  • Mesh
  • load_mesh()
  • Topology
  • Geometry
  • SpatialIndex
  • scalar_r2g()
  • scalar_g2r()
  • vec_rotate_r2g()
  • vec_rotate_g2r()
  • Mesh Class
  • Topology
  • Geometry
  • Spatial Index
  • Coordinate Transformations
  • Readers
• fesomp.plotting
  • plot()
  • regrid()
  • RegridInterpolator
  • transect()
  • interpolate_transect()
  • plot_transect()
  • TransectInterpolator
  • great_circle_path()
  • great_circle_distance()
  • Plot
  • Regrid
  • Transect
• fesomp.diag
  • Sea Ice Diagnostics
  • Vertical Diagnostics
  • Mixed Layer
  • Meridional Overturning
  • Utilities
  • ice_area()
  • ice_volume()
  • ice_extent()
  • hovmoller()
  • volume_mean()
  • heat_content()
  • total_volume()
  • mixed_layer_depth()
  • mixed_layer_depth_interpolated()
  • moc()
  • amoc_index()
  • get_basin_mask()
  • list_moc_basins()
  • hemisphere_mask()
  • get_region_mask()
  • list_available_regions()
  • compute_layer_thickness()
  • select_depth_indices()
  • get_surface_area()
  • Sea Ice
  • Vertical Diagnostics
  • Mixed Layer
  • Meridional Overturning
  • Utilities

Development

• Changelog

Features

Mesh Management

• Flexible I/O: Load meshes from NetCDF or ASCII formats

• Lazy Loading: Topology, geometry, and spatial indices computed on-demand

• Dual Coordinates: Automatic handling of node and element (triangle center) data

• Spatial Queries: Fast nearest-neighbor search, radius queries, and bounding box selection

Data Interpolation

• Three Methods: Nearest neighbor (fast), inverse distance weighting (smooth), and linear interpolation

• Regular Grid: Interpolate unstructured data to regular lon/lat grids

• Caching: Reusable interpolators for efficient multi-variable processing

• Spherical Geometry: Accurate great circle calculations on the sphere

Visualization

• Map Plots: Cartopy integration with multiple projections (PlateCarree, Robinson, Polar, etc.)

• Transect Plots: Vertical cross-sections with automatic vertical coordinate detection

• Customizable: Full control over colormaps, contours, labels, and styling

• Auto-Detection: Automatically determines if data is on nodes/elements and levels/layers

Diagnostics

• Sea Ice: Ice area, volume, and extent calculations

• Vertical: Hovmoller diagrams, heat content, volume-weighted means

• Mixed Layer: Mixed layer depth with various criteria

• Meridional Overturning: MOC and AMOC index calculations

Indices and tables

• Index

• Module Index

• Search Page