diff --git a/README.md b/README.md index b86d729e6700666cf952aefc0efedbfd674ef396..7d1fdb45d451d8b8922973ec4857016038c8d8a8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,28 @@ -EICd - EIC data model {#mainpage} +[TOC] + +EICd - EIC data model ===================== -https://eic.phy.anl.gov/eicd +## Overview + +A podio based data model. + +- https://eic.phy.anl.gov/eicd - this page - [dd4pod](https://eic.phy.anl.gov/npdet/ref_doc/namespacedd4pod.html): data model for dd4hep output which comes with [npdet](https://eic.phy.anl.gov/npdet/). +## Full Description File + +The entire data model is defined with a single YAML file. Here is the current definition: + +\verbinclude eic_data.yaml + + +## Installing ``` +mkdir build && cd build cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eicd -DBUILD_DATA_MODEL=ON +make -j4 install ``` + diff --git a/docs/Doxyfile b/docs/Doxyfile index 325dfb6b1d533af360a89542ff92234d7d0aaa69..5c4639cadd2161dde8455e1ff2f54f156e41a7ef 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "eicd" +PROJECT_NAME = "EICd" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -44,7 +44,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "EIC Data model" +PROJECT_BRIEF = "EIC data model" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 @@ -988,7 +988,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = ../. # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -1002,7 +1002,7 @@ EXAMPLE_PATTERNS = * # irrespective of the value of the RECURSIVE tag. # The default value is: NO. -EXAMPLE_RECURSIVE = NO +EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the @@ -1090,7 +1090,7 @@ INLINE_SOURCES = NO # Fortran comments will always remain visible. # The default value is: YES. -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed.