Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,24 @@ are continually evolving. Contributions and feedback are welcome!
Releases
********

0.6.0 (2026-02-18)
___________________

Breaking Changes
----------------
* CLI: Replaced `--processor` option with `--processor-config` (required) in `rompy postprocess` and `rompy pipeline` commands.
* API: `ModelRun.postprocess()` now requires a `BasePostprocessorConfig` instance instead of a string processor name.
* Pipeline: `LocalPipelineBackend.execute()` now accepts a `BasePostprocessorConfig` instance for the `processor` parameter.

New Features
------------
* Added Pydantic-based postprocessor configuration framework (`BasePostprocessorConfig`, `NoopPostprocessorConfig`).
* Added `--processor-config` CLI option for specifying postprocessor configuration files (YAML/JSON).
* Added `rompy.postprocess.config` entry point group for registering postprocessor configurations.
* Added `rompy backends validate --processor-type` for validating postprocessor configurations.
* Added comprehensive test suite for postprocessor configuration framework.
* Added example postprocessor configuration files.

0.5.0 (2025-07-13)
___________________

Expand Down
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Key Features:
- Templated, reproducible model configuration using pydantic and xarray
- Unified interfaces for grids, data, boundaries, and spectra
- Extensible plugin system for models, data sources, backends, and postprocessors
- Pydantic-based postprocessor configuration with CLI support
- Robust logging and formatting for consistent output and diagnostics
- Example notebooks and comprehensive documentation for rapid onboarding
- Support for local, Docker, and HPC execution backends
Expand All @@ -28,6 +29,42 @@ rompy is under active development—features, model support, and documentation a

See <https://rom-py.github.io/rompy/>

# Postprocessor Configuration

ROMPY now supports Pydantic-based postprocessor configuration via YAML/JSON files.

## Usage

### Postprocess with a config file

```bash
rompy postprocess model_config.yml --processor-config processor.yml
```

### Pipeline with postprocessor config

```bash
rompy pipeline model_config.yml --processor-config processor.yml
```

### Validate a postprocessor config

```bash
rompy backends validate --processor-type noop processor.yml
```

## Example Configuration

```yaml
type: noop
validate_outputs: true
timeout: 3600
env_vars:
DEBUG: "1"
```

See `examples/backends/postprocessor_configs/` for more examples.

# Code Formatting and Pre-commit Hooks

This repository enforces Python code formatting using [black](https://github.com/psf/black) via the pre-commit framework.
Expand Down
Loading