Skip to content

Commit 10c81aa

Browse files
committed
[Doc] Refurbish readme.md
1 parent 0b91da6 commit 10c81aa

File tree

1 file changed

+29
-38
lines changed

1 file changed

+29
-38
lines changed

README.md

+29-38
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,51 @@
22

33
## About
44

5-
The ROOT system provides a set of modules with all the functionality
6-
needed to handle and analyze large amounts of data in a very efficient way.
7-
Having the data defined as a set of objects, specialized storage methods are
8-
used to get direct access to the separate attributes of the selected objects,
9-
without having to touch the bulk of the data. Included are histograming
10-
methods in an arbitrary number of dimensions, curve fitting, function
11-
evaluation, minimization, graphics and visualization classes to allow
12-
the easy setup of an analysis system that can query and process the data
5+
ROOT is a unified software package for the storage, processing, and analysis of
6+
scientific data: from its acquisition to the final visualization in form of highly
7+
customizable, publication-ready plots. It is reliable, performant and well supported,
8+
easy to use and obtain, and strives to maximize the quantity and impact of scientific
9+
results obtained per unit cost, both of human effort and computing resources.
10+
11+
ROOT provides a very efficient storage system for data models,
12+
that demonstrated to scale at the Large Hadron Collider experiments: Exabytes
13+
of scientific data are written in columnar ROOT format.
14+
ROOT comes with histogramming capabilities in an arbitrary number of
15+
dimensions, curve fitting, statistical modelling, minimization, to allow
16+
the easy setup of a data analysis system that can query and process the data
1317
interactively or in batch mode, as well as a general parallel processing
14-
framework, PROOF, that can considerably speed up an analysis.
18+
framework, RDataFrame, that can considerably speed up an analysis, taking
19+
full advantage of multi-core and distributed systems.
1520

16-
Thanks to the built-in C++ interpreter cling, the command, the
17-
scripting and the programming language are all C++. The interpreter
18-
allows for fast prototyping of the macros since it removes the time
19-
consuming compile/link cycle. It also provides a good environment to
20-
learn C++. If more performance is needed the interactively developed
21-
macros can be compiled using a C++ compiler via a machine independent
22-
transparent compiler interface called ACliC.
21+
ROOT is performance critical software written in C++ and enables rapid prototyping
22+
powered by a unique C++ compliant interpreter called Cling.
23+
Cling also enables performant C++ type introspection which is a building block of automatic
24+
interoperability with Python. Thanks to PyROOT, leveraging the cppyy technology,
25+
ROOT offers efficient, on-demand C++/Python interoperability in a uniform cross-language
26+
execution environment.
2327

24-
The system has been designed in such a way that it can query its databases
25-
in parallel on clusters of workstations or many-core machines. ROOT is
26-
an open system that can be dynamically extended by linking external
27-
libraries. This makes ROOT a premier platform on which to build data
28-
acquisition, simulation and data analysis systems.
28+
ROOT fully embraces open-source, it's made with passion by its community,
29+
for the benefit of its community.
2930

3031
[![License: LGPL v2.1+](https://img.shields.io/badge/License-LGPL%20v2.1+-blue.svg)](https://www.gnu.org/licenses/lgpl.html)
3132
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5060/badge)](https://bestpractices.coreinfrastructure.org/projects/5060)
3233

33-
## Cite
34+
## Contribution Guidelines
35+
- [How to contribute](https://github.com/root-project/root/blob/master/CONTRIBUTING.md)
36+
- [Coding conventions](https://root.cern/coding-conventions)
37+
- [Meetings](https://root.cern/meetings)
3438

39+
## Cite
3540
When citing ROOT, please use both the reference reported below and the DOI specific to your ROOT version available [on Zenodo](https://zenodo.org/badge/latestdoi/10994345) [![DOI](https://zenodo.org/badge/10994345.svg)](https://zenodo.org/badge/latestdoi/10994345). For example, you can copy-paste and fill in the following citation:
3641

3742
Rene Brun and Fons Rademakers, ROOT - An Object Oriented Data Analysis Framework,
3843
Proceedings AIHENP'96 Workshop, Lausanne, Sep. 1996,
3944
Nucl. Inst. & Meth. in Phys. Res. A 389 (1997) 81-86.
40-
See also "ROOT" [software], Release vX.YY/ZZ, dd/mm/yyyy,
41-
(Select the right link for your release here: https://zenodo.org/search?page=1&size=20&q=conceptrecid:848818&all_versions&sort=-version).
45+
See also "ROOT" [software], Release vX.YY/ZZ, dd/mm/yyyy
4246

4347
## Live Demo for CERN Users
4448
[![](https://img.shields.io/badge/Launch-SWAN-orange)](http://cern.ch/swanserver/cgi-bin/go?projurl=https://github.com/cernphsft/rootbinder.git)
4549

46-
## Screenshots
47-
These screenshots shows some of the plots (produced using ROOT) presented when the Higgs boson discovery was [announced at CERN](http://home.cern/topics/higgs-boson):
48-
49-
![CMS Data MC Ratio Plot](https://root.cern/gallery/higgs_plots/CMS_Data_MC_Ratio_Plot.png)
50-
51-
![Atlas P0 Trends](https://root.cern/gallery/higgs_plots/Atlas_P0_Trends.png)
52-
5350
See more screenshots on our [gallery](https://root.cern/gallery).
5451

5552
## Installation and Getting Started
@@ -62,11 +59,5 @@ Our ["Getting started with ROOT"](https://root.cern/get_started) page is then th
6259
- [Forum](https://root.cern/forum/)
6360
- [Issue tracker](https://github.com/root-project/root/issues)
6461
* [Previous now read-only Jira issue tracker](https://sft.its.cern.ch/jira/projects/ROOT/issues/ROOT-5820?filter=allopenissues)
65-
- [Mailing lists](https://groups.cern.ch/group/root-dev/default.aspx)
6662
- [Documentation](https://root.cern/guides/reference-guide)
67-
- [Tutorials](https://root.cern/doc/master/group__Tutorials.html)
68-
69-
## Contribution Guidelines
70-
- [How to contribute](https://github.com/root-project/root/blob/master/CONTRIBUTING.md)
71-
- [Coding conventions](https://root.cern/coding-conventions)
72-
- [Meetings](https://root.cern/meetings)
63+
- [Tutorials](https://root.cern/doc/master/group__Tutorials.html)

0 commit comments

Comments
 (0)