Commit c9349747 authored Sep 26, 2022 by Stephan Lachnit

Merge branch 'p-docs-fixes' into 'master'

Minor Fixes for the Manual

See merge request allpix-squared/allpix-squared!869

parents 4ea85c93 2d355974

doc/usermanual/01_introduction/_index.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -2,7 +2,7 @@
		# SPDX-FileCopyrightText: 2022 CERN and the Allpix Squared authors
		# SPDX-License-Identifier: CC-BY-4.0
		title: "Introduction"
		description: "Introduction to the Allpix Squared project."
		description: "A brief introduction to the Allpix Squared framework and its goals."
		weight: 1
		---

doc/usermanual/06_objects/_index.md

+7 −2

Original line number	Diff line number	Diff line
		@@ -6,5 +6,10 @@ description: "Objects which can be used to transfer data between modules."
		weight: 6
		---

		Allpix Squared provides a set of objects which can be used to transfer data between modules. These objects can be sent with
		the messaging system as explained in [Section 4.6](../04_framework/06_messages.md).
		Allpix Squared provides a set of objects which can be used to transfer data between modules and to store the simulation
		results to file. These objects can be read again from file and dispatched to a secondary simulation chain using the
		[ROOTObjectReader](../07_modules/rootobjectreader.md) and [ROOTObjectWriter](../07_modules/rootobjectwriter.md) modules which
		dispatch them via the messaging system as explained in [Section 4.6](../04_framework/06_messages.md).

		Objects stored to a ROOT file can be analyzed using C or Python scripts, the example scripts for both languages described in
		[Section 13](13_additional/root_analysis_macros.md) are provided in the repository.

doc/usermanual/07_modules/_index.md

+4 −4

Original line number	Diff line number	Diff line
		@@ -2,10 +2,10 @@
		# SPDX-FileCopyrightText: 2022 CERN and the Allpix Squared authors
		# SPDX-License-Identifier: CC-BY-4.0
		title: "Modules"
		description: "Description of all available Allpix Squared modules."
		description: "Description and parameter documentation of all available Allpix Squared modules."
		weight: 7
		---

		This section describes all currently available modules in detail. This includes a description of the physics implemented as
		well as possible configuration parameters along with their defaults. For inquiries about certain modules or its
		documentation, the respective maintainers should be contacted directly. The modules are listed in alphabetical order.
		This section describes all currently available modules in detail. This comprises a description of the physics implemented as
		well as a list of all configuration parameters along with their default values. For inquiries about a specific module or its
		documentation, the respective module maintainers should be contacted directly. The modules are listed in alphabetical order.

examples/precise_dut/README.md

+2 −2

Original line number	Diff line number	Diff line
		---
		# SPDX-FileCopyrightText: 2017-2022 CERN and the Allpix Squared authors
		# SPDX-License-Identifier: CC-BY-4.0
		title: "Precise DUT"
		description: "Fast simulation with high precision on the DUT"
		title: "Precise DUT Simulation"
		description: "Fast simulation of reference detectors with high precision on the DUT"
		---

		This example combines features from the "Fast Simulation" and the "TCAD Field Simulation" examples. The setup consists of six telescope planes of Timepix-type detectors for reference tracks and a device under test (DUT), in this case a CLICpix2 detector, in the center of the telescope between the two arms. The goal of this setup is to demonstrate how to perform a fast simulation on the telescope planes while maintaining a high precision on the DUT.

examples/radial_strip/README.md

+2 −2

Original line number	Diff line number	Diff line
		---
		# SPDX-FileCopyrightText: 2022 CERN and the Allpix Squared authors
		# SPDX-License-Identifier: CC-BY-4.0
		title: "Radial Strip"
		description: "Simulation of a radial strip detector"
		title: "Radial Strip Detector"
		description: "Simulation of a silicon detector with radial strip electrodes"
		---

		This example simulates a radial strip detector, which features a trapezoidal shape and strips fanning out radially from a common focal point.