diff --git a/README.md b/README.md index 48bdfef..760698f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ -PECLocalFwk -=========== +# Mēnsūra -A framework to analyse [PlainEventContent files](https://twiki.cern.ch/twiki/bin/viewauth/CMS/PlainEventContentTuples) -locally. The files are produced by [single-top subpackage](https://github.com/andrey-popov/single-top) for CMSSW. In a -normal workflow this step is performed in Grid. The framework allows to read the files, perform a user-defined event -selection, evaluate systematical variations, and enables user to define plugins to calcualte and store desired quantities. +Mensura is a framework to perform physics analysis of data recorded by the [CMS](http://cms.cern.ch) experiment. +It operates with abstracted representations of reconstructed and generator-level objects, such leptons, jets, and missing Et, concentrating on their physical properties rather than details of reconstruction. +Events in input datasets are processed with a set of plugins defined by user, which allows to apply a modular approach. +Distribution includes standard plugins for a number of common tasks such as event selection, reweighting to account for b-tagging scale factors, and others. +The framework supports multithreaded processing. -Documentation for the framework is available in a dedicated [page](https://twiki.cern.ch/twiki/bin/view/CMS/PECLocalFramework) -of [CMS](http://cms.cern.ch) TWiki. Developer notes (including description of releases) are aggregated at -[this page](https://twiki.cern.ch/twiki/bin/view/CMS/PECLocalFrameworkDev). - -Old versions of the framework are hosted at CERN [SVN](https://svnweb.cern.ch/trac/singletop/browser/PECLocalFwk/tags) -service. They have not been incorporated into this repository. +Out of the box, the framework supports reading files with events produced by the [PEC-tuples](https://github.com/andrey-popov/PEC-tuples) package. +However, it is possible to read files of a custom format if user implements appropriate reader plugins.