Skip to content

docs(beams2D): adapt readme and tutorial to use v1 for Beams2D + problem name consistency + list of problems#237

Open
gioelemo wants to merge 2 commits intoIDEALLab:mainfrom
gioelemo:main
Open

docs(beams2D): adapt readme and tutorial to use v1 for Beams2D + problem name consistency + list of problems#237
gioelemo wants to merge 2 commits intoIDEALLab:mainfrom
gioelemo:main

Conversation

@gioelemo
Copy link
Copy Markdown

@gioelemo gioelemo commented Mar 26, 2026

Description

Adapt the README and tutorial notebook to use v1 instead of v0 for the Beams2D problem.
Additionally make the name of the problems consistent with EngiBench paper (no space) and improve the list of problems in the documentation.

Type of change

  • Documentation only change (no code changed)

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files
  • I have run ruff check . and ruff format
  • I have run mypy .
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Reviewer Checklist:

  • The content of this PR brings value to the community. It is not too specific to a particular use case.
  • The tests and checks pass (linting, formatting, type checking). For a new problem, double check the github actions workflow to ensure the problem is being tested.
  • The documentation is updated.
  • The code is understandable and commented. No large code blocks are left unexplained, no huge file. Can I read and understand the code easily?
  • There is no merge conflict.
  • The changes are not breaking the existing results (datasets, training curves, etc.). If they do, is there a good reason for it? And is the associated problem version bumped?
  • For a new problem, has the dataset been generated with our slurm script so we can re-generate it if needed? (This also ensures that the problem is running on the HPC.)
  • For bugfixes, it is a robust fix and not a hacky workaround.

@gioelemo gioelemo changed the title docs(beams2D): adapt readme and tutorial to use v1 for Beams2D docs(beams2D): adapt readme and tutorial to use v1 for Beams2D + problem name consistency + list of problems Mar 26, 2026
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.

1 participant