Documentation: how to run FESTIM in parallel #856

[XinShen-CHN]

Proposed changes

Documentation: how to run FESTIM in parallel #856.

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)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.56%. Comparing base (362cf71) to head (d5ec17c).
Report is 148 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #871   +/-   ##
=======================================
  Coverage   99.55%   99.56%           
=======================================
  Files          61       61           
  Lines        2705     2750   +45     
=======================================
+ Hits         2693     2738   +45     
  Misses         12       12           

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

[RemDelaporteMathurin]

Thanks @XinShen-CHN for adding this!

I see that the documentation test is failing. See my comment below.

@KulaginVladimir do you think this should be at the bottom of this page in "Your first FESTIM script"?

[KulaginVladimir]

@RemDelaporteMathurin, I don't. Since parallel computing doesn't always result in faster computation, I wouldn't put it in the "your first FESTIM script".

Personally, I'd make a separate page that could be filled with some additional info/hints/warnings later.

We could also make a demo to show when parallel computing might speed up a simulation.

[XinShen-CHN]

Thanks @XinShen-CHN for adding this!

I see that the documentation test is failing. See my comment below.

Thank you Remi!

[RemDelaporteMathurin]

Personally, I'd make a separate page that could be filled with some additional info/hints/warnings later.

@XinShen-CHN could you make a new User Guide page "Running in parallel" and move the content there instead?

[RemDelaporteMathurin]

Xin, you need to:

• provide the correct extension for the new file (.rst). Also, avoid blank spaces and uppercase letters in filenames. running_in_parallel.rst would be an appropriate filename.
• add this new file in docs/source/userguide/index.rst if you want it to be counted.

I advise you to try and build the documentation locally on your computer to be able to inspect your changes. Here you will see that these lines don't appear anywhere in the automatically-built documentation.

[XinShen-CHN]

Xin, you need to:

• provide the correct extension for the new file (.rst). Also, avoid blank spaces and uppercase letters in filenames. running_in_parallel.rst would be an appropriate filename.
• add this new file in docs/source/userguide/index.rst if you want it to be counted.

I advise you to try and build the documentation locally on your computer to be able to inspect your changes. Here you will see that these lines don't appear anywhere in the automatically-built documentation.

I see. I'll try to fix it.

Sorry for the delays. I was on a vacation.

[RemDelaporteMathurin]

Hi @XinShen-CHN do you need assistance on this?

[XinShen-CHN]

Hi @XinShen-CHN do you need assistance on this?

Yes, I failed to build the documentation locally.

[RemDelaporteMathurin]

Hi @XinShen-CHN thanks for these changes. I can assist you in building the docs locally. In the meantime, here's a final suggestion (I'll commit): we need to have a title (with # ) in this page to avoid this:

[XinShen-CHN]

Hi @XinShen-CHN thanks for these changes. I can assist you in building the docs locally. In the meantime, here's a final suggestion (I'll commit): we need to have a title (with # ) in this page to avoid this:

Remi, thank you so much!