search

EvanForsythe / ERCnet

9 stars 2 forks source link

Add description of benchmarking to readme #62

Closed EvanForsythe closed 1 year ago

EvanForsythe commented 1 year ago

The new benchmarking feature creates a new output folder. We should have a description of what's happening at this step so that users can interpret the benchmarking data.

Note: the verbiage should include a note like (benchmarking may be inaccurate for very small runs (<1 minute runtime).

EvanForsythe commented 1 year ago

While we're at it, we should do a thorough update to the README to make sure it's still up to date.

tgattsIV commented 1 year ago

Added benchmarking description, but did not verify the entire README contents.