Improve docs

[RemDelaporteMathurin]

Proposed changes

This PR has been a long time coming... Flushing out the User Guide of the documentation.

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
• 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)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7c6ca17) 98.93% compared to head (d64d5e1) 98.99%.
Report is 25 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #681      +/-   ##
==========================================
+ Coverage   98.93%   98.99%   +0.06%     
==========================================
  Files          57       58       +1     
  Lines        2154     2290     +136     
==========================================
+ Hits         2131     2267     +136     
  Misses         23       23              

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

[KulaginVladimir]

Looks nice. Several minor suggestions. @RemDelaporteMathurin, what do you think of adding some information about:

• The Soret coefficient in Materials
• The stepsize settings (adaptive stepsize)
• An example of the PointValue usage in PP

[RemDelaporteMathurin]

Looks nice. Several minor suggestions. @RemDelaporteMathurin, what do you think of adding some information about:

• The Soret coefficient in Materials
• The stepsize settings (adaptive stepsize)
• An example of the PointValue usage in PP

Done! let me know what you think.

[KulaginVladimir]

Perfect! Though I didn't find an example of the InitialCondition usage (nowhere). Maybe, it's also worth adding. As an option, the Boundary conditions section can be extented to Initial & Boundary conditions. Nonetherless, the current version is OK to me.

[RemDelaporteMathurin]

@KulaginVladimir good shout! I added the initial conditions

[RemDelaporteMathurin]

@KulaginVladimir I split ICs and BCs and added the initial conditions from XDMF files to the docs. Once it's compiled you should see it here

[KulaginVladimir]

I think it is a nice guide. Would have been really helpful when I started using FESTIM 😄

[RemDelaporteMathurin]

I think it is a nice guide. Would have been really helpful when I started using FESTIM 😄

Apologies for this... New users have a complete guide now! Thanks for your review!

I'll let @jhdark have a look too and once it's approved then I'll merge it.

[jhdark]

Just some minor typos and grammar from me, although if I ever find a few days free I could go through all the docs more thoroughly. Otherwise thanks a lot for doing this! Its tedious work but hugely beneficial to new users!

[RemDelaporteMathurin]

@jhdark thanks for your feedback. I pushed the suggested changes, we are in no rush to merge this so if you need more time no worries.

[jhdark]

Looks good!