From 57f248b8ad920a3e100b6696caab5500053dbbd8 Mon Sep 17 00:00:00 2001 From: Dmitry Date: Tue, 30 Jan 2024 00:12:11 +0100 Subject: [PATCH] update README --- .gitignore | 3 ++- README.md | 24 +++++++++++++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 4283d84..571abc9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.pyc -*-checkpoint.* \ No newline at end of file +*-checkpoint.* +*-checkpoint \ No newline at end of file diff --git a/README.md b/README.md index 8677268..e9104a0 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,26 @@ # Analysis Facility Benchmark -[https://af-benchmark.readthedocs.io](https://af-benchmark.readthedocs.io/en/latest/) \ No newline at end of file +[https://af-benchmark.readthedocs.io](https://af-benchmark.readthedocs.io/en/latest/) + +🏗️ Work in progress 🚧 + + +This benchmark is designed for generic but comprehensive performance tests of the computing infrastructure at CMS Analysis Facilities. It currently includes the following functionality: + +- Multiple options for code execution: + - Sequential + - Parallelized via `concurrent.futures` + - Parallelized via `Dask` using local cluster + - Parallelized via `Dask` using Gateway cluster +- Multiple methods of loading and reading columns from NanoAOD ROOT files: + - `uproot` + - `coffea.nanoevents` +- Generic operations applied to data in columns: + - Nothing (just open the ROOT file with a given method) + - Load column data into memory + - Perform a simple operation on a column, e.g. `mean()` +- Time profiling +- Measuring size of columns in bytes + +