Skip to content

Commit fccbefa

Browse files
authored
Update README.md
1 parent a97e242 commit fccbefa

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Table of Contents
3131
What is it?
3232
-----------
3333

34-
Hydra is a C++11 compliant and header only framework designed to perform common data analysis tasks on massively parallel platforms. Hydra provides a collection of containers and algorithms commonly used in HEP data analysis, which can deploy transparently OpenMP, CUDA and TBB enabled devices, allowing the user to re-use the same code across a large range of available multi-core CPU and accelerators. The framework design is focused on performance and precision.
34+
Hydra is a C++14 compliant and header only framework designed to perform common data analysis tasks on massively parallel platforms. Hydra provides a collection of containers and algorithms commonly used in HEP data analysis, which can deploy transparently OpenMP, CUDA and TBB enabled devices, allowing the user to re-use the same code across a large range of available multi-core CPU and accelerators. The framework design is focused on performance and precision.
3535

3636
The core algorithms follow as close as possible the implementations widely used in frameworks like ROOT and libraries
3737
like GSL.
@@ -44,36 +44,38 @@ Currently Hydra supports:
4444
* Generation of phase-space Monte Carlo samples with any number of particles in the final states. Sequential decays, calculation of integrals of models over the corresponding phase-space and production of weighted and unweighted samples, which can be flat or distributed following a model provided by the user.
4545
* Sampling of multidimensional pdfs.
4646
* Multidimensional maximum likelihood fits using binned and unbinned data sets.
47+
* Multi-layered simultaneous fit of different models, over different datasets, deploying different parallelization strategies for each model.
4748
* Calculation of S-Plots, a popular technique for statistical unfolding of populations contributing to a sample.
4849
* Evaluation of multidimensional functions over heterogeneous data sets.
4950
* Numerical integration of multidimensional functions using self-adaptive Monte Carlo and quadrature methods.
5051
* Multidimensional sparse and dense histogramming of large samples.
5152
* Object-based interface to FFTW and CuFFT for performing Fast Fourier Transform in CPU and GPU.
5253
* FFT based one-dimensional convolution for arbitrary signal and kernel shapes.
5354
* Booststrap and real cubic spiline for datasets on CPU and GPU.
54-
* Sobol low discrepance sequences up to 3667 dimensions
55+
* Sobol low discrepance sequences up to 3667 dimensions.
5556

5657
Hydra also provides a bunch of custom types, optimized containers and a number of algorithms and constructs to maximize performance, avoiding unnecessary usage of memory and without losing the flexibility and portability to compile and run the same code across different platforms and deployment scenarios.
5758

5859

59-
For example, just changing .cu to .cpp in any source code written only using the Hydra and standard C++11 is enough
60+
For example, just changing .cu to .cpp in any source code written only using the Hydra and standard C++14 is enough
6061
to compile your application for OpenMP or TBB compatible devices using GCC or other compiler in a machine without a NVIDIA GPU installed.
6162

62-
In summary, by using Hydra the user can transparently typical bottle-neck calculations to a suitable parallel device and get speed-up factors ranging from dozens to hundreds.
63+
In summary, by using Hydra the user can transparently implement and dispatch typical bottle-neck calculations to a suitable parallel device and get speed-up factors ranging from dozens to hundreds.
6364

6465

6566

6667
Hydra and Thrust
6768
----------------
6869

6970
Hydra is implemented on top of the [Thrust library](https://thrust.github.io/) and relies strongly on Thrust's containers, algorithms and backend management systems.
70-
The official version of Thrust supports tuples with maximum ten elements. In order to overcome this limitation, Hydra uses the
71+
The official version of Thrust supports tuples with maximum ten elements. In order to overcome this limitation, Hydra uses an
7172
[unofficial version, forked from the original, by Andrew Currigan and collaborators](https://github.com/andrewcorrigan/thrust-multi-permutation-iterator).
7273
This version implements variadic tuples and related classes, as well as provides some additional functionality, which are missing in the official Thrust.
74+
In order to keep Hydra uptodated with the latest bug-fixes and architetural improvements in Thrust, at each Hydra release, the official [Thrust library](https://thrust.github.io/) is patched with the Currigan's variadic tuple implementation.
7375

74-
The version of Thrust distributed with Hydra is maintained by [MultithreadCorner](https://github.com/MultithreadCorner). It is basically a fork of Currigan's repository, which was merged with the latest official release available in GitHub (Thrust 1.9.7).
76+
So, version of Thrust distributed with Hydra is maintained by [MultithreadCorner](https://github.com/MultithreadCorner). It is basically a fork of Currigan's repository, which was merged with the latest official release available in GitHub (Thrust 1.9.7).
7577

76-
***Hydra does not depend or conflict with the official Thrust library distributed with the CUDA-SDK.***
78+
***Hydra does not depend or conflict with the official Thrust library distributed with the CUDA-SDK.***
7779

7880

7981
Supported Parallel Backends
@@ -97,7 +99,7 @@ nvcc -I/path/to/Hydra -Xcompiler -fopenmp -DHYDRA_HOST_SYSTEM=OMP -DHYDRA_DEVIC
9799
The available "host" and "device" backends can be freely combined.
98100
Two important features related to Hydra's design and the backend configuration:
99101

100-
* If CUDA backend is not used, [NVCC and the CUDA runtime](https://developer.nvidia.com/cuda-toolkit) are not necessary. The programs can be compiled with GCC, Clang or other host compiler compatible with C++11 directly.
102+
* If CUDA backend is not used, [NVCC and the CUDA runtime](https://developer.nvidia.com/cuda-toolkit) are not necessary. The programs can be compiled with GCC, Clang or other host compiler compatible with C++14 support directly.
101103
* Programs written using only Hydra, Thrust, STL and standard c++ constructs, it means programs without any raw CUDA code or calls to the CUDA runtime API, can be compiled with NVCC, to run on CUDA backends, or a suitable host compiler to run on OpenMP , TBB and CPP backends. **Just change the source file extension from .cu to .cpp, or something else the host compiler understands.**
102104

103105

@@ -134,11 +136,12 @@ Installation and requirements
134136

135137
Hydra is a header only library, so no build process is necessary to install it.
136138
Just place the `hydra` folder and its contents where your system can find it.
137-
The library run on Linux systems and requires at least a host compiler supporting C++11. To use NVidia's GPUs, CUDA 8 or higher is required.
138-
A suite of examples demonstrating the basic features of the library are included in the `examples` folder.
139+
The framework runs on Linux systems and requires at least a host compiler supporting C++14. To use NVidia's GPUs, CUDA 9.2 or higher is required.
140+
A suite of examples demonstrating the basic features of the framework is included in the `examples` folder.
139141
All the examples are organized in .inl files, which implements the `main()` function. These files are included by .cpp and .cu
140142
files, which are compiled according with the availability of backends. TBB and CUDA backends requires the installation of the corresponding libraries and runtimes.
141143
These code samples uses, but does not requires [ROOT](https://root.cern.ch/) for graphics, and [TCLAP](http://tclap.sourceforge.net/) library for process command line arguments.
144+
Some functionality in Hydra requires Eigen, GSL, CuFFT and FFTW.
142145

143146
Examples
144147
--------
@@ -162,10 +165,12 @@ The examples are listed below:
162165
4. __misc__ : multiarray_container, multivector_container, variant_types
163166
5. __numerical_integration__ : adaptive_gauss_kronrod, gauss_kronrod, plain_mc, vegas
164167
6. __phase_space__ : phsp_averaging_functor, phsp_evaluating_functor, phsp_reweighting, phsp_basic, phsp_unweighting, phsp_chain, phsp_unweighting_functor
165-
7. __random__ : basic_distributions, sample_distribution
166-
8. __root_macros__ : macros to run examples in ROOT
168+
7. __phys__ : breit_wigner_plus_chebychev, breit_wigner_plus_polynomial, crystal_ball_plus_exponential, dalitz_plot, double_gaussian_plus_exponential, gaussian_plus_argus,
169+
ipatia_plus_argus, particle_mass, pseudo_experiment
170+
8. __random__ : basic_distributions, sample_distribution
171+
9. __root_macros__ : macros to run examples in ROOT
167172

168-
Each compiled example executable will have an postfix (ex.: _cuda, _omp, _tbb) to indicate the deployed device backend.
173+
Each compiled example executable will have an postfix (ex.:_cpp, _cuda, _omp, _tbb) to indicate the deployed device backend.
169174
All examples use CPP as host backend.
170175

171176

@@ -208,7 +213,7 @@ Here’s what you should do if you need help or would like to contribute:
208213

209214
1. If you need help or would like to ask a general question, subscribe and use https://groups.google.com/forum/#!forum/hydra-library-users.
210215
2. If you found a bug, use GitHub issues.
211-
3. If you have an idea, suggestion of whatever, use GitHub issues.
216+
3. If you have an idea, suggestion or whatever, use GitHub issues.
212217
4. If you want to contribute, submit a pull request https://github.com/MultithreadCorner/Hydra.
213218

214219
Author
@@ -219,7 +224,7 @@ Hydra was created and is maintained by [Antonio Augusto Alves Jr](https://github
219224
Acknowledgement
220225
---------------
221226

222-
Hydra's development has been supported by the [National Science Foundation](http://nsf.gov/index.jsp)
227+
Initial Hydra's development was supported by the [National Science Foundation](http://nsf.gov/index.jsp)
223228
under the grant number [PHY-1414736](http://nsf.gov/awardsearch/showAward?AWD_ID=1414736).
224229
Any opinions, findings, and conclusions or recommendations expressed in this material are those of
225230
the developers and do not necessarily reflect the views of the National Science Foundation.

0 commit comments

Comments
 (0)