Update the information in the XDMF section

[XinShen-CHN]

Proposed changes

Some updated information in the XDMF section of the documentation. #799

Types of changes

What types of changes does your code introduce to FESTIM?

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Code refactoring
• [ x ] Documentation Update (if none of the other choices apply)
• New tests

Checklist

• Black formatted
• Unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

[RemDelaporteMathurin]

Thanks for this contribution @XinShen-CHN!

Just letting you know that you can visualise the compiled documentation here.

you can also compile the documentation locally. To do so follow the Documentation guide in the Developer’s guide.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (362cf71) to head (69437de).
Report is 115 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #801   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files          61       61           
  Lines        2705     2705           
=======================================
  Hits         2693     2693           
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RemDelaporteMathurin]

Thanks @XinShen-CHN for that first contribution 🎉

Here are a few remarks that would need to be addressed before merging.

[RemDelaporteMathurin]

You need one blank line to have the list correctly displayed (you can visualise the rendered results in the compiled docs).

Suggested change

	- Make sure to have the h5 file in the same directory as the XDMF file
	- Make sure to have the h5 file in the same directory as the XDMF file

[RemDelaporteMathurin]

Maybe another remark/tip would be to not modify the name of the files after their creation by FESTIM.

This would result in not being able to open the file in paraview because the XDMF points to the h5 file!

can you add this please?

[XinShen-CHN]

Thank you very much!

Sure, I'll modify the documentation and add the new tip.

[RemDelaporteMathurin]

Looks good to me! I'll leave this open a little while longer to give others a chance to make some comments and then we can merge this PR.