Skip to content

User Guide

Welcome to the Earth2Studio user guide. Use this section to learn how Earth2Studio is installed, how the package is organized, and how its core components fit together.

If you want to run code immediately, start with the examples. If you are contributing to the package, jump to the developer guide.

  • Install

    Set up Earth2Studio, optional dependencies, model extras, containers, and cache configuration.

    Install guide

  • Overview

    Learn the package philosophy, pipeline model, data movement pattern, and coordinate conventions.

    Package overview

  • Core Components

    Understand prognostic models, diagnostic models, data sources, perturbations, IO backends, and statistics.

    Components

  • Advanced Usage

    Work with checkpointing, batch dimensions, AutoModels, lexicons, and technical notes.

    Advanced usage

  • Developer Guide

    Find development setup, dependency, style, testing, documentation, and build guidance.

    Developer guide

  • Support

    Find troubleshooting notes and answers to common questions.

    Support