Update `profiling/report.py` and its documentation

[tztsai]

Description

The PR focuses on updating the profiling/report.py file and its documentation within the pyrealm project. It introduces new optional arguments to the script for enhanced control over profiling results, including options to avoid saving the results or generating plots, to filter filenames via regex, and to limit the number of benchmarks in the plots. Additionally, it makes changes to the documentation to reflect these updates and provides information on the usage of these new arguments.

Type of change

• [x] New feature (non-breaking change which adds functionality)

Key checklist

• [x] Make sure you've run the pre-commit checks: $ pre-commit run -a
• [x] All tests pass: $ poetry run pytest

Further checks

• [x] Code is commented, particularly in hard-to-understand areas
• [x] Tests added that prove fix is effective or that feature works

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.58%. Comparing base (858e5e9) to head (e0853fa).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #188 +/- ## ======================================== Coverage 94.58% 94.58% ======================================== Files 28 28 Lines 1514 1514 ======================================== Hits 1432 1432 Misses 82 82 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.