API Documentation#
This section contains the API documentation for the user-facing components of
the satrain package.
Core Modules#
Data Access and Management - Dataset downloading, file management, and data loading
Evaluation Framework - Model evaluation and benchmarking tools
Metrics - Statistical metrics for precipitation retrieval assessment
Input Configuration - Input data processing and configuration
Target Configuration - Target precipitation data handling
PyTorch Integration#
PyTorch Utilities - PyTorch integration helpers
PyTorch Datasets - Dataset classes for tabular and spatial data
Utilities and Configuration#
Configuration - Package configuration management
Command Line Interface - CLI tools for data management
Utilities - General utility functions
Logging - Logging configuration and utilities
Tiling - Dataset tiling functionality
Plotting - Visualization functions
Baselines - Baseline retrieval algorithms
Quick Reference#
Data Access#
{py:func}satrain.data.get_files- Get dataset files matching criteria{py:func}satrain.data.download_missing- Download missing data files{py:func}satrain.data.load_tabular_data- Load tabular data for ML
Evaluation#
{py:class}satrain.evaluation.Evaluator- Main evaluation framework{py:class}satrain.evaluation.InputFiles- Input file management
Configuration#
{py:mod}satrain.config- Package configuration management{py:mod}satrain.cli- Command-line interface
PyTorch Datasets#
{py:class}satrain.pytorch.datasets.SatRainTabular- Tabular dataset loader{py:class}satrain.pytorch.datasets.SatRainSpatial- Spatial dataset loader