Skip to content

docs: move dataset generation guide to introduction#263

Open
xarthurx wants to merge 2 commits into
mainfrom
docs/dataset-generation-slurm
Open

docs: move dataset generation guide to introduction#263
xarthurx wants to merge 2 commits into
mainfrom
docs/dataset-generation-slurm

Conversation

@xarthurx

@xarthurx xarthurx commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Move the Airfoil dataset generation submission script into a new Introduction page
  • Use a shorter sidebar label: Data Generation (Slurm)
  • Link from the generic Slurm utilities page to the new guide
  • Replace informal HPC-team wording with a cluster-policy warning

Screenshot

Updated Data Generation (Slurm) docs page

Validation

  • uv run python -m sphinx -E -b dirhtml docs docs/_build/dirhtml
  • uv run python -m sphinx -b doctest docs docs/_build/doctest
  • uvx pre-commit run --files docs/index.md docs/introduction/dataset_generation_slurm.md docs/utils/slurm.md engibench/utils/slurm/init.py tests/tools/fake_sbatch.py

Addresses #261

Copilot AI review requested due to automatic review settings July 7, 2026 09:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR relocates the Airfoil dataset-generation Slurm submission guide from the Slurm utilities page into the Introduction section, improving discoverability and aligning wording with cluster policy guidance.

Changes:

  • Add a new Introduction page documenting the end-to-end “Dataset Generation via Slurm” workflow (Airfoil example).
  • Link to the new guide from the Slurm utilities documentation and update the sidebar label.
  • Update Slurm utility docstring wording to replace informal HPC-team phrasing; fix the fake_sbatch test tool shebang.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/tools/fake_sbatch.py Fix shebang to the standard /usr/bin/env python3.
engibench/utils/slurm/__init__.py Update reduce() docstring wording around login-node size limits / cluster policy.
docs/utils/slurm.md Add link to the new dataset-generation guide and remove the embedded Airfoil example script.
docs/introduction/dataset_generation_slurm.md New end-to-end dataset-generation submission guide (Airfoil example).
docs/index.md Add the new guide to the Introduction toctree with the requested sidebar label.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread engibench/utils/slurm/__init__.py
Comment thread docs/introduction/dataset_generation_slurm.md Outdated
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