|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
1 | 3 | """ |
2 | | -modvx — Model Verification Toolkit |
3 | | -==================================== |
| 4 | +Package entry points and convenience imports for modvx. |
4 | 5 |
|
5 | | -A community Python package for computing spatial verification metrics |
6 | | -(Fractions Skill Score, RMSE, and more) for gridded forecast experiments |
7 | | -against satellite-based precipitation observations. |
| 6 | +This module exposes the primary public classes and helpers that make up the modvx verification toolkit. It provides a concise, importable surface for constructing configurations, building work-units, running parallel processing backends, performing I/O and data validation, computingperformance metrics, and producing plots. Importing from this module is the recommended way for downstream tools to access the canonical API. |
8 | 7 |
|
9 | | -Classes |
10 | | -------- |
11 | | -TaskManager Orchestrates work-unit enumeration, logging, and execution. |
12 | | -ParallelProcessor MPI-based parallelism via mpi4py (graceful serial fallback). |
13 | | -FileManager All I/O: forecast/observation loading, caching, output writing. |
14 | | -DataValidator Grid preparation, regridding, mask application, QC checks. |
15 | | -PerfMetrics Verification scores (FSS, RMSE, …). |
16 | | -Visualizer Plotting: FSS-vs-lead-time, horizontal precip maps, diffs. |
| 8 | +Author: Rubaiat Islam |
| 9 | +Institution: Mesoscale & Microscale Meteorology Laboratory, NCAR |
| 10 | +Email: mrislam@ucar.edu |
| 11 | +Date: February 2026 |
| 12 | +Version: 1.0.0 |
17 | 13 | """ |
18 | 14 |
|
19 | 15 | __version__ = "0.1.0" |
20 | 16 |
|
21 | | -from modvx.config import ModvxConfig, load_config |
| 17 | +from modvx.config import ModvxConfig, load_config_from_yaml |
22 | 18 | from modvx.task_manager import TaskManager |
23 | 19 | from modvx.parallel import ParallelProcessor |
24 | 20 | from modvx.file_manager import FileManager |
|
28 | 24 |
|
29 | 25 | __all__ = [ |
30 | 26 | "ModvxConfig", |
31 | | - "load_config", |
| 27 | + "load_config_from_yaml", |
32 | 28 | "TaskManager", |
33 | 29 | "ParallelProcessor", |
34 | 30 | "FileManager", |
|
0 commit comments