Development

Here are some guidelines for those who wish to contribute to icclim development.

Contents:

• Release process
  • Automatic Release
  • Conda-forge Checklist
  • Enabling Auto-merge on Bot PRs
• Continuous integration
• Add A New Climate Index
  • Workflow Overview
  • FAIR4RS In Practice
  • Before You Add Code
  • Common Cases
  • Where To Look
  • FAIR4RS In Practice
  • Code Clarity Rules
  • Testing Checklist
• Provenance Implementation Plan
  • Why this is needed
  • Design goals
  • FAIR4RS Alignment
  • What to record
  • icclim-specific mandatory fields
  • Output artifacts
  • Current implementation status
  • Why the main output path is the right integration point
  • Recommended implementation shape
  • Initial integration steps
  • Remaining extensions
  • Schema guidance
  • Guardrails
  • Tests to add
  • What was learned from idownscale
• Provenance Integration Guide
  • Why this exists
  • Relation to SWIRRL-style provenance
  • Produced artifacts
  • Recommended integration pattern
  • What frontends should display
  • What backend services should persist
  • Recommended mapping for portal backends
  • Using provenance in user support
  • Using provenance in SWIRRL-style traceability views
  • Using provenance for result catalogs
  • Handling missing fields
  • Adapter guidance for graph-based provenance systems
  • Explicit graph-mapping examples
  • What not to do
  • Field priorities for SWIRRL or Climate4Impact integration
  • Why the sidecar should remain file-oriented
  • Frontend guidance for FAIR4RS-oriented reuse
  • Current schema areas most useful to integrators
  • Practical next step for integrators
• Bootstrap optimization summary
  • Scope
  • Initial state
  • Main implementation changes
  • Retained production boundary
  • Validation and results
  • What remains out of scope
  • Impact on xclim bootstrap code
  • Recommended next work
• Bootstrap maintainability audit
  • Scope and method
  • High-level verdict
  • Areas that are in good shape
  • Areas that still need care
  • What this audit says about older design patterns
  • Working rules for the next branches
  • Over-engineering checklist
  • Implementation plan
  • Definition of success
• Percentile bootstrap
  • Current strategy
  • Unsupported cases
  • Performance notes
  • Validation rules
• Bootstrap architecture
  • Design goals
  • Guiding principles
  • Bootstrap families
  • Capability matrix
  • Reusable bootstrap primitives
  • Module boundaries
  • Naming and readability rules
  • Readability beyond bootstrap
  • FAIR4RS implications
  • Recommended implementation order
  • What success looks like
• icclim contribution guide
  • Getting started
  • Documentation contribution
  • Add new standard indices
  • Add new operators for user indices
  • Improve icclim API
  • Other contributions
• Climpact Comparison Protocol
  • Why this protocol exists
  • Assessment checklist
  • Important constraint
  • Repo workflow
  • Supported manual comparators
  • How to interpret the result
  • Recommended regression coverage