mgrid Documentation

mgrid is a Python package for generating variable-resolution spherical meshes for MPAS-based atmospheric models (MPAS, MONAN, and compatible systems).

Getting Started

• Installation
  • Requirements
  • Recommended: Conda Environment
  • Quick Install (pip only)
  • Dependencies Overview
  • Verification
  • Troubleshooting
• Quick Start
  • Installation
  • Unified Workflow
  • Configuration File Structure
  • Quick Example
  • Goiás Example (Complete)
  • Using Pre-made MPAS Grids
  • CLI Reference
  • Python API
  • Next Steps
• Complete Pipeline
  • Pipeline Overview
  • Step-by-Step Guide
  • Complete Pipeline Function
  • Command-Line Example
  • Output Files
  • Running MPAS/MONAN
  • Performance Considerations

User Guide

• Region Types
  • CircularRegion
  • PolygonRegion
  • Nesting Regions
  • Configuration File Format
• Configuration
  • Basic Structure
  • Global Parameters
  • Region Parameters
  • Complete Example
  • Loading Configuration
  • Saving Configuration
  • Validation
• Examples
  • Example 1: Uniform Resolution Grid
  • Example 2: Icosahedral Grid
  • Example 3: Single Circular Region
  • Example 4: State Boundary from Shapefile
  • Example 5: Multi-Resolution Nested Grid
  • Example 6: Complete Pipeline
  • Example 7: Command-Line Pipeline
  • Example 8: Extract Polygon from Shapefile

API Reference

• API Reference
  • High-Level Functions
  • Region Classes
  • I/O Functions
  • Limited-Area Integration
  • Geometry Utilities
  • Grid Object

Documentação (PT-BR)

• Instalação
  • Requisitos
  • Recomendado: Ambiente Conda
  • Instalação Rápida (apenas pip)
  • Visão Geral das Dependências
  • Verificação
  • Solução de Problemas
• Guia Rápido
  • Instalação
  • Fluxo de Trabalho Unificado
  • Estrutura do Arquivo de Configuração
  • Exemplo Rápido
  • Exemplo Goiás (Completo)
  • Usando Grades MPAS Pré-geradas
  • Referência do CLI
  • API Python
  • Próximos Passos
• Pipeline Completo
  • Visão Geral do Pipeline
  • Guia Passo a Passo
  • Função de Pipeline Completo
  • Exemplo via Linha de Comando
  • Arquivos de Saída
  • Executando MPAS/MONAN
  • Considerações de Desempenho
  • Considerações para o MONAN

Indices and tables

• Index

• Module Index

• Search Page