Doc updates #354
Merged
Doc updates #354
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
glesur
commented
Oct 18, 2025
glesur
commented
- add documentation for CI
- add fix proposed to issue BUG: VTK corrupted for 1D runs with MPI #348 with mpi IO in FAQs
add fix proposed to issue with mpi IO in FAQs
glesur
added
documentation
There was a problem hiding this comment.
Pull Request Overview
Documentation updates to improve developer experience and troubleshooting support, including comprehensive testing documentation and MPI troubleshooting guidance.
- Added comprehensive CI testing documentation explaining GitHub Actions workflows, test execution, and developer usage
- Added detailed documentation for the
idfxTestclass with command-line options, methods, and usage examples - Added FAQ entry for OpenMPI corruption issue with VTK output and workaround solution
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/source/testing/idfxTest.rst | Complete documentation for the idfxTest class including constructor options, methods, and usage examples |
| doc/source/testing.rst | New CI testing documentation explaining GitHub Actions workflows and test execution |
| doc/source/index.rst | Added testing documentation to main documentation index |
| doc/source/faq.rst | Added FAQ entry for MPI VTK output corruption issue with OpenMPI workaround |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Merged
glesur
added a commit
that referenced
this pull request
Oct 19, 2025
## [2.2.02] 2025-10-18 ### Changed - Added a module to add explicit units (#338) - fixed a bug that could lead to incorrect profiling information on non-blocking cuda loops (#341) - fixed a bug that could lead to incorrect energy budget when shearing box and fargo were both enabled (#346) - fixed a bug that led to incorrect BX2 reconstruction when axis is not used on both sides of the domain (#345) - fixed a bug that led to incorrect reflective boundary conditions on B when DIMENSIONS < 3 (#345) - fixed a bug that led to incorrect dust stopping time when the adiabatic equation of state is used with "size" drag law (#353) ### Added - documentation for the continuous integration (#354) --------- Co-authored-by: Victor Réville <victorreville@gmail.com> Co-authored-by: Hal Bal <vreville@irap.omp.eu> Co-authored-by: Jean Kempf <jean.kempf@irap.omp.eu> Co-authored-by: Victor Réville <47865059+vreville@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.