Skip to content

Commit

Permalink
update readme with cmake changes
Browse files Browse the repository at this point in the history
  • Loading branch information
vvolkl committed Nov 19, 2020
1 parent f2b44b3 commit 00b642b
Showing 1 changed file with 7 additions and 31 deletions.
38 changes: 7 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# K4FWCore
# k4FWCore (Key4HEP FrameWork Core)


K4FWCore (Key4HEP FrameWork Core) is a package comprising core Gaudi components for the Key4HEP software framework
k4FWCore is a Gaudi package that provides the PodioDataService, that allows to use podio-based event data models like edm4hep in gaudi workflows.


## Components

### Basic I/O

#### PodioDataSvc
#### k4DataSvc


Data service extended to handle PODIO types and collections.
Component wrapping the PodioDataService to handle PODIO types and collections.


#### PodioInput
Expand All @@ -26,27 +25,6 @@ Algorithm to write data to output file on disk.

Algorithm with a simple float as output, for testing and adding parameters to jobs.

### Background Overlay


#### PileupOverlayAlg

Algorithm that overlays its input with data from an external (background) data source.

#### RangePileup

Tool to specify pile-up parameters.

#### ConstPileUp

Tool to specify pile-up parameters.

#### PoissonPileUp

Tool to specify pile-up parameters.




## Dependencies

Expand All @@ -56,18 +34,16 @@ Tool to specify pile-up parameters.

* Gaudi

## Installation
## Installation and downstream usage.

K4FWCore is a Gaudi-based project and uses the Gaudi CMake configuration
k4FWCore is a cmake project. After setting up the dependencies (use for example `source /cvmfs/sw.hsf.org/key4hep/setup.sh`)


```
mkdir build install
cd build;
cmake .. -DCMAKE_INSTALL_PREFIX=../install
cmake ..
make install
```


0 comments on commit 00b642b

Please sign in to comment.