Skip to content

Patch README for current project layout - #12

Merged
juliendrapeau merged 2 commits into
devfrom
sync
May 22, 2026
Merged

juliendrapeau merged 2 commits into
devfrom
sync

Conversation

@juliendrapeau

Copy link
Copy Markdown
Owner

Summary

  • Add workflow/plots/ to the directory tree, which was introduced in v0.5.0 but missing from the README.
  • Align experiments/<stage>/<exp>/ subtree and hpc/config/ examples with the layout shipped in v0.5.0.
  • Add the clusters_example.yaml copy step that was absent from the HPC quick-start section.

Changes

README corrections

  • Directory tree: add workflow/plots/ entry; replace stale top-level sweeps/, configs/, data/, results/ entries with the experiments/<stage>/<exp>/ subtree; add hpc/config/ subdirectory entry.
  • "Run locally" code block: update sweep script path and results path to match the experiments/ layout.
  • HPC quick-start block: add cp hpc/config/clusters_example.yaml hpc/config/clusters.yaml alongside the existing config and submit copy steps.
  • "Adapt for your project" step 3: update the sweep path and explain how to add experiments by copying the sweeps/ directory.

Version

Bumped to 0.5.1.

Add workflow/plots/ to the directory tree, align the experiments/ and
hpc/config/ subtree examples with current layout, and include the
clusters_example.yaml copy step that was missing from the HPC setup
section.
@github-actions

Copy link
Copy Markdown

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
59 55 93% 90% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: c28c85a by action🐍

@juliendrapeau
juliendrapeau merged commit 34b2138 into dev May 22, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant