README.md

awiesm.pycmor_helpers

AWI-ESM helpers for pycmor - utilities for working with pycmor in the AWI-ESM modeling framework.

Installation

This project uses pixi for dependency management.

Using pixi

# Install dependencies
pixi install

# Run tests
pixi run test

# Run tests with coverage
pixi run test-cov

# Format code
pixi run format

# Lint code
pixi run lint

# Type check
pixi run typecheck

Traditional installation

pip install -e .

Development

The project uses:

• xarray for n-dimensional labeled arrays
• pycmor for CMOR operations
• pytest for testing
• black for code formatting
• ruff for linting
• mypy for type checking

Project Structure

awiesm.pycmor_helpers/
├── src/
│   └── awiesm/
│       └── pycmor_helpers/
│           └── __init__.py
├── tests/
│   ├── __init__.py
│   └── test_basic.py
├── docs/
├── pyproject.toml
└── README.md

License

MIT