diff --git a/README.md b/README.md index e5006d97800e0a2dd50282e2d7dc814995938399..3b18a95c21383bc42a8a32ade4e1e12fa01ae53f 100644 --- a/README.md +++ b/README.md @@ -154,5 +154,21 @@ ACTS has a Combinatorial Kalman Filter (CKF) which does both track finding and f [GenFit](https://github.com/GenFit/GenFit) is a generic track fitting tool built on ROOT and the tgeo library. +## Adding a New Algorithm to Juggler + +Algorithm implementations must belong to the `juggler` library so they can be used in the event processing framework. +Because `juggler` was built on top of the [Gaudi Framework](gaudi-framework.readthedocs.io/) the machinery for building a new algorithm +and adding into an existing event processing sequence is quite easy. + +The basic tasks for adding a new algorithm are: + +1. Identify the data inputs and outputs. Use existing structures in the data model or add new ones if needed. +2. Implement the algorithm in c++. Create a new merge request (or preferably start with a new issue then click blue button "create merge request") for the juggler repository. Mark as `Draft:` if needed. +3. Merge the algorithm into the master. Bug the maintainers or SWG to help with this. +4. Add to an existing or create a new benchmark in the `reconstruction_benchmark` repository. + + + +