User Guide

Welcome to the Earth-2 MIP user guide. Here you can find all relevant information on getting Earth-2 MIP running as well as understanding key concepts / philsophies in the package.

Danger

This user guide is presently under construction. Given the Beta state of Earth-2 MIP information present in the user guide may be slightly delayed to the state of the code.

Get Started

• Installation
  • Install from Source (Recommended)
  • Install from Release Wheel
  • Installing from PyPi
• Earth-2 MIP Environments
  • Conda Environment
  • Docker Environment
  • Singularity / Apptainer Environment
• Optional Dependicies
  • Models
  • Development

Concepts / Features

• Concepts
  • Model Wrappers
  • Forecast
  • Translating between Model Wrappers
  • Data Source
  • Model package
• Diagnostics
  • Motivation
  • Using Diagnostics
  • Custom Diagnostics
  • Known Limitations
• Inference Workflows
  • General Inference
  • Scoring

Utilities

• Command Line Utilities

Customization

• Bring your own model
  • Module Interface
  • Time Loop Interface
• Bring you own data

Support

• Troubleshooting