diff --git a/README.md b/README.md index f404967..14cad0d 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,13 @@ - Windows - Will most likely not work +### Tools + +- Profiling + - [gprof](https://ftp.gnu.org/old-gnu/Manuals/gprof-2.9.1/html_mono/gprof.html) + - [scalasca](https://www.scalasca.org/) + - [scorep](https://www.vi-hps.org/projects/score-p) + ### Libraries - Python @@ -74,6 +81,38 @@ If you have any problems running the scripts, you might have to run this instead python3 scripts/ ``` +## Performance + +This section aims to give an idea to the time it takes for the program to +run so that you know a bit what to expect if you decide to run it for +yourself. + +### CPU + +The times mentioned here are times achieved on a computer with these +specifications: + +- CPU model + - Intel i7-9850H +- Threads + - 12 +- Clock speed + - 4.6GHz + +### Times + +All times mentioned use the **evolve_RK4** method. + +Running a simulation with 100 particles without particle interactions over +40000 steps takes around 1.8 seconds. With particle interactions, it takes +around 4.8 seconds. + +**potential_resonance_wide_sweep** takes around 56 seconds to complete. + +**potential_resonance_narrow_sweep** takes around 172 seconds to complete. + +**potential_resonance_narrow_sweep_interaction** takes around 936 seconds to +complete. ## Credits