Migration Guide

Note

This section is under development. Migration guides and version upgrade information will be added in future releases.

Overview

This guide will help users migrate between different versions of rompy-oceanum and understand breaking changes in the API.

Coming Soon

This section will cover:

  • Version Migration: Step-by-step guides for upgrading between major versions

  • Breaking Changes: Documentation of API changes and deprecations

  • Configuration Updates: How to update configuration files for new versions

  • Compatibility Matrix: Version compatibility with rompy and oceanum CLI

  • Migration Tools: Automated tools to help with configuration updates

Current Status

For now, please:

  1. Check the CHANGELOG.md in the repository for version-specific changes

  2. Review the release notes for breaking changes

  3. Test thoroughly in a development environment before upgrading production systems

  4. Consult the GitHub issues for migration-related questions

Version History

Upgrade Checklist

When upgrading rompy-oceanum:

  1. Backup configurations: Save current working configurations

  2. Review release notes: Check for breaking changes

  3. Update dependencies: Ensure compatible versions of rompy and oceanum CLI

  4. Test in development: Validate functionality before production deployment

  5. Update documentation: Review any configuration or API changes

For now, please refer to:

See Also