Docs: add section on basic performance benchmark

[sphuber]

The section provides a basic script to benchmark the performance of an AiiDA installation by launching a number of ArithmeticAddCalculation jobs. The script by default automatically sets up the required Code and localhost Computer. All created nodes are automatically deleted from the database at the end.

The documentation gives instructions on how to run the script and provides example output of a run on a typical work station including completion times for runs with variable number of daemon workers. This should give users an idea of the performance of their installation.

[ltalirz]

thanks a lot @sphuber !

I've added a few comments on the docs (haven't yet looked at the code much; I assume that will be fine)

[sphuber]

@ltalirz I have addressed the comments and added a section to topics on performance. Even though the latter isn't really part of the focus of this PR, I already added some text as to not have it completely empty. But maybe should not go down the rabbithole too much for this PR on that part.

[ltalirz]

I added one further commit in #5723

If that seems fine, please cherry-pick it here and close that PR

[sphuber]

If that seems fine, please cherry-pick it here and close that PR

Thanks, all fine. I cherry-picked the commit here. Just corrected a mistake in the script that was probably added by accident and some minor corrections in the docs (broken label).

[ltalirz]

Thanks for the fixes!

I see I still introduced some remaining issues?

<string>:1: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/howto/installation.rst:341: WARNING: Inline literal start-string without end-string.
/home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/topics/performance.rst:53: WARNING: download file not readable: /home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/topics/include/scripts/performance_benchmark_base.py

[sphuber]

/home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/topics/performance.rst:53: WARNING: download file not readable: /home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/topics/include/scripts/performance_benchmark_base.py

This was just an incorrect link (it is relative, but we moved it to another subfolder).

/home/docs/checkouts/readthedocs.org/user_builds/aiida-core/checkouts/5635/docs/source/howto/installation.rst:341: WARNING: Inline literal start-string without end-string.

This was actually a nasty one. The error messages of Sphinx are often not very useful. The problem was the following

``ArithmeticAddCalculation``s

Apparently, you cannot have this s straight after the closing literal block. What made it even more confusing is that this was on line 342 whereas the error message states 341 😅 . Anyway, should be fixed now.

[ltalirz]

thanks a lot @sphuber !

[ltalirz]

what do you mean by that specifically?

until this section is fleshed out, you could also just leave it out

[sphuber]

I had originally added this but already removed it when cherry-picking your commit, where you suggested to remove it. Think you were looking at an outdated diff.

What I mean with the environment is the runtime for AiiDA, i.e. is it installed with Conda, in virtual-env, or system wide, or maybe running in a container, etc. It is not quite clear if and how much of an impact it could have, but I thought it would be good to have the list complete. But now I think it is fine to just omit it for the time being.