diff --git a/src/docs/background.md b/src/docs/background.md new file mode 100644 index 0000000000000000000000000000000000000000..9c2957141a087d5fb6c685d6446ce23ccb7f6f26 --- /dev/null +++ b/src/docs/background.md @@ -0,0 +1,29 @@ +--- +title: "Background" +--- + + +## The "Framework" Discussion + +In the nuclear and particle physics communities many software frameworks exists. +They come in all sizes and scopes. +It is important to remember why frameworks exist: to solve a problem that is more difficult without the framework. +That said, adopting a framework introduces tight coupling in software which makes it inflexible and difficult to maintain. +Therefore, ***adopting a framework for the sake of using a framework is never a good idea***. + +### The "geometry problem" + +The detector description framework called `DD4hep`, at its core, is aimed at +solving the "geometry problem". The geometry problem relates the detector +description used in simulation or experiment and the reconstruction geometry. +An illustrative example is the following. Give a channel number representing a +pixel in a silicon detector, a hit in that channel represents a 3D point with +an uncertainty equal to dimensions of the pixel. Constructing the pixel in +simulation and providing a robust look of the geometry based on a channel +number are very different tasks. + +A tool or framework that allows this look up of geometry from channel number is +important for flexible use of independent tracking and reconstruction tools. + +### The I + diff --git a/src/docs/tools.md b/src/docs/tools.md new file mode 100644 index 0000000000000000000000000000000000000000..22cdf1dfa1a0a226daa6080c9fd98543273e6554 --- /dev/null +++ b/src/docs/tools.md @@ -0,0 +1,29 @@ +--- +title: "Software Tools" +--- + + +## The "Framework" Discussion + +In the nuclear and particle physics communities many software frameworks exists. +They come in all sizes and scopes. +It is important to remember why frameworks exist: to solve a problem that is more difficult without the framework. +That said, adopting a framework introduces tight coupling in software which makes it inflexible and difficult to maintain. +Therefore, ***adopting a framework for the sake of using a framework is never a good idea***. + +### The "geometry problem" + +The detector description framework called `DD4hep`, at its core, is aimed at +solving the "geometry problem". The geometry problem relates the detector +description used in simulation or experiment and the reconstruction geometry. +An illustrative example is the following. Give a channel number representing a +pixel in a silicon detector, a hit in that channel represents a 3D point with +an uncertainty equal to dimensions of the pixel. Constructing the pixel in +simulation and providing a robust look of the geometry based on a channel +number are very different tasks. + +A tool or framework that allows this look up of geometry from channel number is +important for flexible use of independent tracking and reconstruction tools. + +### The I +