Add comprehensive GitHub Copilot instructions for Cheetah development workflow #574
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Cheetah accelerator physics simulation codebase.What's Included
The instructions provide validated commands and workflows for:
Development Setup:
pip install -e .
(validated with proper 5+ minute timeouts)pip install pytest pytest-benchmark pytest-cov
pip install black isort flake8 flake8-bugbear
Testing Framework:
test_drift.py
,test_quadrupole.py
,test_cavity.py
(1-second runtime, 100% pass rate)--benchmark-only
flagocelot-collab
Code Quality Workflow:
black cheetah/ tests/ docs/ setup.py --exclude="/.ipynb/"
isort . --profile black
flake8 .
Manual Validation Scenarios:
Working Python code for testing core functionality including:
Key Features
Repository Structure Guidance
The instructions include navigation help for:
cheetah/accelerator/
- Core physics elementscheetah/particles/
- Particle beam classescheetah/converters/
- Integration with other codestests/
- Test suite organizationdocs/
- Documentation and examplesThis ensures GitHub Copilot agents can immediately work productively in the codebase with validated commands, proper timeout expectations, and clear validation procedures for beam physics simulations.
Fixes #573.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.