Skip to content

Commit 82b9ff7

Browse files
committed
Add README.md to create front-page documentation for both Github repo and Doxygen
1 parent 19bee8b commit 82b9ff7

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# artdaq-daqinterface Front Page
2+
3+
## About the framework
4+
5+
The _artdaq_ toolkit is a data-acquisition framework designed for high-energy physics experiments. It provides a flexible, reliable backbone for data transfers and has several locations where users can perform custom analysis tasks using the _art_ framework.
6+
7+
The _artdaq_ suite consists of the following packages:
8+
9+
* [trace](https://art-daq.github.io/artdaq_doxygen/trace): High-performance message logging
10+
* [artdaq-core](https://art-daq.github.io/artdaq_doxygen/artdaq-core): Data formats used by the artdaq toolkit
11+
* [artdaq-utilities](https://art-daq.github.io/artdaq_doxygen/artdaq-utilities): Online tools, primarily metrics reporting
12+
* [artdaq-mfextensions](https://art-daq.github.io/artdaq_doxygen/artdaq-mfextensions): Extensions to the MessageFacility product which are useful in DAQ context
13+
* [artdaq](https://art-daq.github.io/artdaq_doxygen/artdaq): Application and data transfer framework
14+
* [artdaq-core-demo](https://art-daq.github.io/artdaq_doxygen/artdaq-core-demo): Data formats used by the artdaq demonstration system
15+
* [artdaq-demo](https://art-daq.github.io/artdaq_doxygen/artdaq-demo): "User" implementations for the artdaq demonstration system
16+
* [artdaq-daqinterface](https://art-daq.github.io/artdaq_doxygen/artdaq-daqinterface): Command line run control and example configurations
17+
* [artdaq-database](https://art-daq.github.io/artdaq_doxygen/artdaq-database): Bindings for MongoDB or local "filesystemdb" configuration databases
18+
* [artdaq-epics-plugin](https://art-daq.github.io/artdaq_doxygen/artdaq-epics-plugin): Metric endpoint for the EPICS control system
19+
20+
## About this package
21+
22+
This package is a Python-based run control implementation for _artdaq_, performing automatic system configuration and bookkeeping tasks. It also serves as the repository for the _artdaq-demo_ example configurations which are used as the _artdaq_ framework's regression test suite.

0 commit comments

Comments
 (0)