Warning, /acts/docs/examples/examples.rst is written in an unsupported language. File is not indexed.
0001 Examples
0002 ========
0003
0004 ACTS ships with a comprehensive set of examples. These examples leverage a
0005 custom event-processing framework, that is expressly **not intended to be used
0006 in any kind of production environment**. These examples demonstrate how to set
0007 up and configure different components in the ACTS library to assemble a track
0008 reconstruction chain.
0009
0010
0011 At the time of writing, there are two aspects to the ACTS examples:
0012
0013 #. Example executables for different purposes. This is the original form of
0014 examples provided by ACTS. A large number of separate executables are be built
0015 if ``-DACTS_BUILD_EXAMPLES=ON``, the exact set is also influenced by which
0016 plugins are enabled in the build. These executables are configured by a number of
0017 command line options, for example to set the number of events to be processed,
0018 or which output formats to read from / write to.
0019
0020 #. Standalone Performance and Analysis applications based on ROOT. These applications
0021 are built on top of the ROOT based output writers of the ``Examples`` folder, they
0022 comprise of track reconstruction performance validation and material validation
0023 code.
0024
0025 #. Python bindings for the various components of the examples. These bindings
0026 allow more flexible combination of the example components into scripts, and can
0027 overcome the complexity of the large number of executables and command line
0028 options. The idea is that these scripts will serve as true examples, where
0029 modifications to the actual python code will be easy, and encouraged.
0030
0031
0032 .. note:: This section of the documentation contains a set of *how-to* guides,
0033 which describe different example executables, and how to combine them
0034 with one another to assemble several workflows.
0035
0036 .. warning:: Please, do not use the event-processing framework or the example
0037 executables in a production environment! They are meant for demonstration
0038 and prototyping purposes only!
0039
0040 .. toctree::
0041 :maxdepth: 2
0042
0043 Python bindings <python_bindings>
0044 OpenDataDetector full chain <full_chain_odd>
0045 alignment
0046 How-to guides <howto/howto>
