docs: Tracking in a nutshell (#1399)

acts-project · Sep 15, 2022 · 6b97a09 · 6b97a09
1 parent 4ad5016
commit 6b97a09
Show file tree

Hide file tree

Showing 34 changed files with 1,079 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,7 +44,7 @@
 smartquotes = True
 numfig = True
 
-myst_enable_extensions = ["dollarmath", "colon_fence"]
+myst_enable_extensions = ["dollarmath", "colon_fence", "amsmath"]
 myst_heading_anchors = 3
 
 # -- Options for HTML output --------------------------------------------------

diff --git a/docs/core/clustering.md b/docs/core/clustering.md
@@ -0,0 +1,6 @@
+(clustering_core)=
+# Clustering
+
+:::{note}
+This is a stub!
+:::
diff --git a/docs/core/core.rst b/docs/core/core.rst
@@ -14,6 +14,8 @@ tools related to one particular subject, i.e. experiment geometry or vertexing.
    magnetic_field
    material
    propagation
+   clustering
+   spacepoint_formation
    seeding
    track_fitting
    track_finding

diff --git a/docs/core/eventdata.md b/docs/core/eventdata.md
@@ -6,6 +6,11 @@ This section is largely **outdated** and will be replaced in the future.
 
 ## Track parametrization
 
+:::{tip}
+An introduction to track parametrization concepts can be found in
+[](track_parametrization).
+:::
+
 A trajectory in a magnetic field is generally parameterized by a set of at least
 five parameters (when being bound to a surface). Two different categories are
 used in Acts: so-called bound parameters, i.e. parameter bound to a surface and

diff --git a/docs/core/geometry.md b/docs/core/geometry.md
@@ -1,3 +1,4 @@
+(geometry_impl)=
 # Geometry module
 
 The ACTS geometry model is strongly based on the ATLAS Tracking geometry. Its

diff --git a/docs/core/material.rst b/docs/core/material.rst
@@ -1,3 +1,5 @@
+.. _material_core:
+
 Material
 ========
 

diff --git a/docs/core/propagation.md b/docs/core/propagation.md
@@ -1,3 +1,4 @@
+(propagation_impl)=
 # Propagation and extrapolation
 
 The track propagation is an essential part of track reconstruction. This section describes the high-level classes and concepts used for this task in Acts.

diff --git a/docs/core/seeding.rst b/docs/core/seeding.rst
@@ -1,3 +1,5 @@
+.. _seeding_core:
+
 Track Seeding
 ==============
 

diff --git a/docs/core/spacepoint_formation.md b/docs/core/spacepoint_formation.md
@@ -0,0 +1,7 @@
+(spacepoint_formation_core)=
+
+# Spacepoint formation
+
+:::{note}
+This is a stub!
+:::
diff --git a/docs/core/track_finding.md b/docs/core/track_finding.md
@@ -1 +1,9 @@
 # Track Finding
+
+:::{note}
+This is a stub!
+:::
+
+(ckf_core)=
+## Combinatorial Kalman Filter
+
diff --git a/docs/core/track_fitting.md b/docs/core/track_fitting.md
@@ -1 +1,12 @@
 # Track Fitting
+
+:::{note}
+This is a stub!
+:::
+
+(gsf_core)=
+## Gaussian Sum Filter
+
+(kf_core)=
+## Kalman Filter
+
diff --git a/docs/core/vertexing.md b/docs/core/vertexing.md
@@ -1 +1,6 @@
+(vertexing_core)=
 # Vertexing
+
+:::{note}
+This is a stub!
+:::
diff --git a/docs/figures/tracking/cca.svg b/docs/figures/tracking/cca.svg
diff --git a/docs/figures/tracking/clustering.svg b/docs/figures/tracking/clustering.svg
diff --git a/docs/figures/tracking/finding.svg b/docs/figures/tracking/finding.svg
diff --git a/docs/figures/tracking/geometry_detail.svg b/docs/figures/tracking/geometry_detail.svg