Skip to content

Doc updates - #354

Merged
glesur merged 3 commits into
developfrom
docUpdates
Oct 18, 2025
Merged

Doc updates#354
glesur merged 3 commits into
developfrom
docUpdates

Conversation

@glesur

Copy link
Copy Markdown
Contributor

add fix proposed to issue with mpi IO in FAQs
@glesur
glesur requested a review from CopilotOctober 18, 2025 14:53
@glesurglesur added documentation Improvements or additions to documentation doc label for documentation related things to be done labels Oct 18, 2025

CopilotAI 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

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 idfxTest class 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.

FileDescription
doc/source/testing/idfxTest.rstComplete documentation for the idfxTest class including constructor options, methods, and usage examples
doc/source/testing.rstNew CI testing documentation explaining GitHub Actions workflows and test execution
doc/source/index.rstAdded testing documentation to main documentation index
doc/source/faq.rstAdded 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.

Comment threaddoc/source/faq.rst Outdated
glesurand others added 2 commits October 18, 2025 16:55
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@glesur
glesur merged commit cde3a14 into developOct 18, 2025
38 checks passed
@glesurglesur mentioned this pull request Oct 18, 2025
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>
@glesur
glesur deleted the docUpdates branch April 22, 2026 08:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doclabel for documentation related things to be donedocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@glesur