Skip to content

Refactor repository structure to match fz-Model template#2

Merged
yannrichet-asnr merged 4 commits intomainfrom
copilot/refactor-repository-template-fz-model
Dec 5, 2025
Merged

Refactor repository structure to match fz-Model template#2
yannrichet-asnr merged 4 commits intomainfrom
copilot/refactor-repository-template-fz-model

Conversation

Copy link
Contributor

Copilot AI commented Dec 5, 2025

Aligns fz-MCNP with the standard fz-Model template structure for consistency across Funz plugin repositories.

Directory Structure

  • Move example files to examples/ (flattened from root, no subdirectory)
  • Add tests/test_plugin.py with validation suite (model files, calculator configs, example files, fz integration)

Naming Convention

  • Rename .fz/calculators/Localhost_MCNP.jsonlocalhost_MCNP.json
  • Update all references (Localhost_MCNPlocalhost_MCNP) across documentation

Documentation

  • Remove unnecessary documentation files: CONTRIBUTING.md, MIGRATION.md, QUICKSTART.md
  • Keep only README.md and LICENSE to match template
  • Update paths to reference examples/godiva.inp
  • Simplify .gitignore (43 lines removed)

CI/CD

  • Add .github/workflows/ci.yml with comprehensive tests:
    • JSON validation for models and calculators
    • Shell script syntax checking
    • fz framework integration tests
    • Plugin structure validation
    • Documentation checks

Jupyter Notebook

  • Add example_usage.ipynb demonstrating:
    • Installation and setup
    • Variable parsing and compilation
    • Running MCNP calculations
    • Parametric studies
    • Result visualization

Before:

results = fz.fzr("godiva.inp", {"r": [8.5, 8.741, 9.0]}, "MCNP", 
                 calculators="Localhost_MCNP")

After:

results = fz.fzr("examples/godiva.inp", {"r": [8.5, 8.741, 9.0]}, "MCNP",
                 calculators="localhost_MCNP")

The repository now matches the canonical structure used by other fz-* plugins.

Original prompt

refactor repository to match template fz-Model


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: yannrichet-asnr <148193180+yannrichet-asnr@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor repository to match template fz-Model Refactor repository structure to match fz-Model template Dec 5, 2025
Copilot AI requested a review from yannrichet-asnr December 5, 2025 13:47
@yannrichet-asnr
Copy link
Member

@copilot go closer to template fz-Model: most .md files are not needed, CI missing, notebook missing, subdir examples/MCNP not needed

Copilot AI and others added 2 commits December 5, 2025 13:59
…, flatten examples

Co-authored-by: yannrichet-asnr <148193180+yannrichet-asnr@users.noreply.github.com>
Co-authored-by: yannrichet-asnr <148193180+yannrichet-asnr@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 5, 2025

@copilot go closer to template fz-Model: most .md files are not needed, CI missing, notebook missing, subdir examples/MCNP not needed

Done! Changes made to match fz-Model template:

  1. ✅ Removed CONTRIBUTING.md, MIGRATION.md, QUICKSTART.md (only README.md and LICENSE remain)
  2. ✅ Added .github/workflows/ci.yml with tests for structure validation
  3. ✅ Added example_usage.ipynb notebook
  4. ✅ Flattened examples/ directory (files moved from examples/MCNP/ to examples/ directly)

Final structure now matches fz-Model exactly. See commits 4d2b539 and c4fc844.

@yannrichet-asnr yannrichet-asnr marked this pull request as ready for review December 5, 2025 14:13
@yannrichet-asnr yannrichet-asnr merged commit f23abe4 into main Dec 5, 2025
3 checks passed
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.

2 participants