From adf85addb701324bfffb4508656ed5692532793e Mon Sep 17 00:00:00 2001
From: Nicolas de Sereville <deserevi@ipno.in2p3.fr>
Date: Tue, 5 Jan 2016 15:09:43 +0100
Subject: [PATCH] + Update READMEs
---
README/README.BENCHMARKS.md | 64 +++++++++++++++++++++++++++++++++++++
README/README.md | 16 +++++-----
2 files changed, 72 insertions(+), 8 deletions(-)
diff --git a/README/README.BENCHMARKS.md b/README/README.BENCHMARKS.md
index 48ecde37f..c352409a7 100644
--- a/README/README.BENCHMARKS.md
+++ b/README/README.BENCHMARKS.md
@@ -3,3 +3,67 @@ README file for running NPTool benchmarks
Contents
--------
+
+1. Why benchmarks?
+2. Prerequisities
+3. CATS: a multi-wire low-pressure tracking system
+4. GASPARD: a silicon array for particle spectroscopy
+
+
+
+## Why benchmarks?
+Benchmarks play an important role to check the installation or upgrade integrity
+of the NPTool package. They are also useful for comparing CPU performances on
+different computer platforms. So far two benchmarks are included in the NPTool
+package. The first one analyses experimental data from a beam tracker detector
+using the _npanalysis_ facility, while the second one runs a silicon array
+simulation using the _npsimulation_ facility and display some basics
+control spectra. Each benchmark produces figures that can be compared to the
+reference figures provided in NPTool. These two benchmarks cover all the core
+functionalities of NPTool's framework.
+
+
+
+## Prerequisities
+You need to dowmnoad additional files to be able to run the benchmarks. In the
+$NPTOOL directory, do the following:
+
+```
+$ git clone https://github.com/adrien-matta/NPData
+
+```
+
+
+
+## CATS: a multi-wire low-pressure tracking system
+CATS consists of two low pressure multi-wire proportional chambers with one plane
+of anode wires placed between two cathode planes, respectively segmented into 28
+vertical or horizontal strips \cite{Ott99}. It was designed to provide
+event-by-event particle tracking in experiments with radioactive beams at GANIL.
+
+The benchmark can be run from the $NPTOOL/Benchmarks/cats directory with the
+following command:
+```
+$ npanalysis -D benchmark_cats.detector -C calibration.txt -R RunToTreat.txt -O benchmark_cats
+```
+
+To display the results run the command:
+```
+$ root -l ShowResult.C
+```
+
+Alternatively, you can run the `benchmark_cats.sh` script which runs the
+analysis and display the results.
+
+
+Experimental data for the present benchmark comes from the interaction of a
+<sup>58</sup>Ni ion beam at 75 MeV/u in the CATS detector. A mask with a known
+pattern was inserted in front of CATS in order to calibrate the position
+reconstruction. Results that should be obtained when running the benchmark
+are shown in Fig.~\ref{f:cats}. The mask pattern including circular holes of
+different diameters is clearly observed.
+Aside from testing the position reconstruction for the CATS
+detector, this benchmark validates the calibration manager facility and the
+_npanalysis_ utility.
+
+
diff --git a/README/README.md b/README/README.md
index 5aa34b17e..ccc8ff56f 100644
--- a/README/README.md
+++ b/README/README.md
@@ -8,14 +8,14 @@ Contents
Directory nptool/ :
-- README - directory containing important information
-- LICENSE - usage terms and conditions
-- NPLib - directory containing the NPTool core layer
-- NPSimulation - directory containing the Monte Carlo simulation files
-- Inputs - directory containing input files
-- Outputs - directory containing ROOT ouput files generated by the npsimulation and npanalysis modules
-- Benchmarks - directory containing benchmark tests
-- Examples - directory containing some NPTool examples
+- README - directory containing important information
+- LICENSE - usage terms and conditions
+- [NPLib](README.NPLIB.md) - directory containing the NPTool core layer
+- [NPSimulation](README.NPSIMULATION.md) - directory containing the Monte Carlo simulation files
+- Inputs - directory containing input files
+- Outputs - directory containing ROOT ouput files generated by the npsimulation and npanalysis modules
+- [Benchmarks](README.BENCHMARKS.md) - directory containing benchmark tests
+- [Examples](README.EXAMPLES.md) - directory containing some NPTool examples
--
GitLab