Skip to content

✨ Add Copilot instructions for ICESEE repository#23

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/setup-copilot-instructions
Draft

✨ Add Copilot instructions for ICESEE repository#23
Copilot wants to merge 2 commits intomainfrom
copilot/setup-copilot-instructions

Conversation

Copy link

Copilot AI commented Oct 15, 2025

Overview

This PR implements GitHub Copilot instructions for the ICESEE repository as requested in issue #[issue_number]. The instructions will help Copilot provide more contextually relevant code suggestions and better assist developers working on this project.

Changes

Created .github/copilot-instructions.md with comprehensive guidance including:

Project Context

  • Overview: ICESEE is a data assimilation framework for ice sheet models (ISSM, Icepack, Lorenz-96)
  • Technology Stack: Python 3.6+, NumPy, SciPy, MPI4py, Firedrake, H5py, Zarr
  • Purpose: Ensemble-based data assimilation using Ensemble Kalman Filter (EnKF) variants

Developer Guidance

  • Project Structure: Directory organization showing src/, applications/, config/ layout
  • Coding Standards: Python naming conventions, documentation patterns (file headers with author/date/description)
  • Key Concepts: Data assimilation terminology, ensemble management, forecast/analysis steps
  • Common Tasks: Adding new models, working with parallelization (MPI/Dask/Ray), data storage patterns

Technical Details

  • EnKF implementation patterns (Stochastic vs Deterministic variants)
  • YAML configuration parameter usage
  • HDF5/Zarr data storage conventions
  • Parallelization best practices (MPI context awareness, thread management)
  • External model integration specifics for Icepack, ISSM, and Lorenz-96

Benefits

With these instructions, GitHub Copilot will:

  • Understand the scientific computing context and data assimilation concepts
  • Follow established code organization and naming patterns
  • Suggest appropriate parallelization approaches
  • Generate code consistent with the project's file header and documentation style
  • Better assist with model integration tasks

References

Follows best practices documented at https://gh.io/copilot-coding-agent-tips

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.github.com
    • Triggering command: curl -L -s REDACTED (dns block)
  • gh.io
    • Triggering command: curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #22


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: KYANJO <56065060+KYANJO@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for the repository ✨ Add Copilot instructions for ICESEE repository Oct 15, 2025
Copilot AI requested a review from KYANJO October 15, 2025 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants