add cmake doc (#607)

* add cmake doc * remove whitespace * Update doc/cmake.md Co-authored-by: Thomas Madlener <[email protected]> * Update doc/cmake.md Co-authored-by: Thomas Madlener <[email protected]> * include first PR feedback * Update doc/cmake.md Co-authored-by: Thomas Madlener <[email protected]> * Update doc/cmake.md Co-authored-by: Thomas Madlener <[email protected]> * Update doc/cmake.md Co-authored-by: Thomas Madlener <[email protected]> * Fix link rendering. * Update doc/cmake.md Co-authored-by: Andre Sailer <[email protected]> * Remove advanced section in docs --------- Co-authored-by: Thomas Madlener <[email protected]> Co-authored-by: Andre Sailer <[email protected]>
AIDASoft · Jun 4, 2024 · 7db028f · 7db028f
1 parent 108d56c
commit 7db028f
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/doc/cmake.md b/doc/cmake.md
@@ -0,0 +1,45 @@
+# Building a new data model library with CMake
+
+PODIO exposes multiple CMake macros to enable the building of data model libraries.
+For a package developer tutorial on CMake, please have a look [here](https://hsf-training.github.io/hsf-training-cmake-webpage/). PODIO follows the same conventions used therein.
+
+## Exported CMake functions and macros
+The file [cmake/podioMacros.cmake](https://github.com/AIDASoft/podio/blob/master/cmake/podioMacros.cmake) provides the following functions for external use:
+
+  1. `PODIO_GENERATE_DATAMODEL` - generate the data model from provided yaml file
+  2. `PODIO_ADD_DATAMODEL_CORE_LIB` - compile the generated data model
+  3. `PODIO_ADD_ROOT_IO_DICT` - configure ROOT I/O backend and interface to Python
+  4. `PODIO_ADD_SIO_IO_BLOCKS` - configure SIO backend
+
+Their exact parameters and functionality are documented in the file mentioned above. Below a few examples.
+
+## A simple example
+After a proper `find_package(podio REQUIRED)`, the C++ code of the new data model `newdm` can be created and compiled via
+
+```cmake
+# generate the c++ code from the yaml definition
+PODIO_GENERATE_DATAMODEL(newdm newdm.yaml headers sources)
+
+# compile the core data model shared library (no I/O)
+PODIO_ADD_DATAMODEL_CORE_LIB(newdm "${headers}" "${sources}")
+
+# generate and compile the ROOT I/O dictionary for the default I/O system
+PODIO_ADD_ROOT_IO_DICT(newdmDict newmdm "${headers}" src/selection.xml)
+```
+For an explicit choice of I/O backends one needs to add the `IO_BACKEND_HANDLERS` parameter and then generate and compile the corresponding backends, like shown below for the ROOT and SIO backends:
+
+```cmake
+# generate the c++ code from the yaml definition
+PODIO_GENERATE_DATAMODEL(newdm newdm.yaml headers sources IO_BACKEND_HANDLERS "ROOT;SIO")
+
+# compile the core data model shared library (no I/O)
+PODIO_ADD_DATAMODEL_CORE_LIB(newdm "${headers}" "${sources}")
+
+# generate and compile the ROOT I/O dictionary for the default I/O system
+PODIO_ADD_ROOT_IO_DICT(newdmDict newmdm "${headers}" src/selection.xml)
+
+# compile the SIOBlocks shared library for the SIO backend
+PODIO_ADD_SIO_IO_BLOCKS(newdm "${headers}" "${sources}")
+```
+
+For a complete example, please have a look at [EDM4hep](https://github.com/key4hep/EDM4hep/blob/main/edm4hep/CMakeLists.txt)
diff --git a/doc/index.rst b/doc/index.rst
@@ -15,6 +15,7 @@ Welcome to PODIO's documentation!
    examples.md
    frame.md
    userdata.md
+   cmake.md
    advanced_topics.md
    templates.md
    python.md