Update example docs

new file: examples-docs/Basic/BatchJob1.rst new file: examples-docs/Basic/BatchJob2.rst new file: examples-docs/Basic/BatchJobShared.rst new file: examples-docs/Basic/BoxRotatedAroundItsCorner.rst new file: examples-docs/Basic/EnvironmentSource.rst new file: examples-docs/Basic/ParallelWorlds.rst new file: examples-docs/Basic/ParticleSourcesFromGroup.rst new file: examples-docs/Basic/QtShapeTest.rst new file: examples-docs/Basic/VoxelMaterialsInDividedComponents.rst modified: examples-docs/Basic/index.rst new file: examples-docs/Brachytherapy/.DS_Store deleted: examples-docs/MVLinac/Flattener.rst new file: examples-docs/MVLinac/Flattener18MV.rst new file: examples-docs/MVLinac/Flattener6MV.rst new file: examples-docs/MVLinac/TestComponent.rst new file: examples-docs/MVLinac/VRT_1a.rst new file: examples-docs/MVLinac/VRT_1b.rst new file: examples-docs/MVLinac/VRT_2.rst new file: examples-docs/MVLinac/VRT_3.rst new file: examples-docs/MVLinac/VRT_HD.rst modified: examples-docs/MVLinac/index.rst new file: examples-docs/Optical/PixelatedDetector.rst modified: examples-docs/Optical/index.rst new file: examples-docs/Patient/.DS_Store new file: examples-docs/Patient/PatientInIEC_1.rst new file: examples-docs/Patient/PatientInIEC_2.rst new file: examples-docs/Patient/PatientInIEC_2_time_feature.rst new file: examples-docs/Patient/PatientInIEC_3.rst modified: examples-docs/Patient/index.rst new file: examples-docs/Scoring/OriginCount.rst modified: examples-docs/Scoring/index.rst deleted: examples-docs/SpecialComponents/Jaws.rst new file: examples-docs/TimeFeature/RasterScanOnMovingTarget.rst new file: examples-docs/TimeFeature/RotatingCylinderWithPhiCut.rst modified: examples-docs/TimeFeature/index.rst deleted: examples/Nozzle/NbParticlesInTime.txt
topasmc · Jul 15, 2021 · 8ab6ef8 · 8ab6ef8
1 parent 63d7aee
commit 8ab6ef8
Show file tree

Hide file tree

Showing 36 changed files with 155 additions and 112 deletions.
diff --git a/examples-docs/Basic/BatchJob1.rst b/examples-docs/Basic/BatchJob1.rst
@@ -0,0 +1,4 @@
+BatchJob1.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/BatchJob1.txt
diff --git a/examples-docs/Basic/BatchJob2.rst b/examples-docs/Basic/BatchJob2.rst
@@ -0,0 +1,4 @@
+BatchJob2.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/BatchJob2.txt
diff --git a/examples-docs/Basic/BatchJobShared.rst b/examples-docs/Basic/BatchJobShared.rst
@@ -0,0 +1,4 @@
+BatchJobShared.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/BatchJobShared.txt
diff --git a/examples-docs/Basic/BoxRotatedAroundItsCorner.rst b/examples-docs/Basic/BoxRotatedAroundItsCorner.rst
@@ -0,0 +1,4 @@
+BoxRotatedAroundItsCorner.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/BoxRotatedAroundItsCorner.txt
diff --git a/examples-docs/Basic/EnvironmentSource.rst b/examples-docs/Basic/EnvironmentSource.rst
@@ -0,0 +1,4 @@
+EnvironmentSource.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/EnvironmentSource.txt
diff --git a/examples-docs/Basic/ParallelWorlds.rst b/examples-docs/Basic/ParallelWorlds.rst
@@ -0,0 +1,4 @@
+ParallelWorlds.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/ParallelWorlds.txt
diff --git a/examples-docs/Basic/ParticleSourcesFromGroup.rst b/examples-docs/Basic/ParticleSourcesFromGroup.rst
@@ -0,0 +1,4 @@
+ParticleSourcesFromGroup.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/ParticleSourcesFromGroup.txt
diff --git a/examples-docs/Basic/QtShapeTest.rst b/examples-docs/Basic/QtShapeTest.rst
@@ -0,0 +1,4 @@
+QtShapeTest.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/QtShapeTest.txt
diff --git a/examples-docs/Basic/VoxelMaterialsInDividedComponents.rst b/examples-docs/Basic/VoxelMaterialsInDividedComponents.rst
@@ -0,0 +1,4 @@
+VoxelMaterialsInDividedComponents.txt
+---------------------
+
+.. literalinclude:: /examples/Basic/VoxelMaterialsInDividedComponents.txt
diff --git a/examples-docs/Basic/index.rst b/examples-docs/Basic/index.rst
@@ -5,20 +5,29 @@ Basic
 	:maxdepth: 1
 
 	AllParameterForms
+	BatchJob1
+	BatchJob2
+	BatchJobShared
+	BoxRotatedAroundItsCorner
 	DividedComponents
 	DNAModelByRegions
 	Emittance_Gaussian
 	Emittance_Twiss
 	EmModelByRegions
+	EnvironmentSource
 	FlatteningFilter
 	Isotope
 	LayeredMassGeometry
 	OneBox
 	OneBoxRotate
 	OneBoxTranslate
+	ParallelWorlds
+	ParticleSourcesFromGroup
 	PhysicsSetting
+	QtShapeTest
 	ShapeTestWithAllParameters
 	ShapeTestWithOnlyRequiredParameters
 	Spectrum
 	TwoBeams
 	VolumetricSource
+	VoxelMaterialsInDividedComponents
diff --git a/examples-docs/Brachytherapy/.DS_Store b/examples-docs/Brachytherapy/.DS_Store
diff --git a/examples-docs/MVLinac/Flattener.rst b/examples-docs/MVLinac/Flattener.rst
diff --git a/examples-docs/MVLinac/Flattener18MV.rst b/examples-docs/MVLinac/Flattener18MV.rst
@@ -0,0 +1,6 @@
+.. _example_linac_flattener18mv:
+
+Flattener18MV.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/Flattener18MV.txt
diff --git a/examples-docs/MVLinac/Flattener6MV.rst b/examples-docs/MVLinac/Flattener6MV.rst
@@ -0,0 +1,6 @@
+.. _example_linac_flattener6mv:
+
+Flattener6MV.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/Flattener6MV.txt
diff --git a/examples-docs/MVLinac/TestComponent.rst b/examples-docs/MVLinac/TestComponent.rst
@@ -0,0 +1,6 @@
+.. _example_linac_test_component:
+
+TestComponent.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/TestComponent.txt
diff --git a/examples-docs/MVLinac/VRT_1a.rst b/examples-docs/MVLinac/VRT_1a.rst
@@ -0,0 +1,6 @@
+.. _example_linac_vrt1:
+
+VRT_1a.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/VRT_1a.txt
diff --git a/examples-docs/MVLinac/VRT_1b.rst b/examples-docs/MVLinac/VRT_1b.rst
@@ -0,0 +1,6 @@
+.. _example_linac_vrt1b:
+
+VRT_1b.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/VRT_1b.txt
diff --git a/examples-docs/MVLinac/VRT_2.rst b/examples-docs/MVLinac/VRT_2.rst
@@ -0,0 +1,6 @@
+.. _example_linac_vrt2:
+
+VRT_2.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/VRT_2.txt
diff --git a/examples-docs/MVLinac/VRT_3.rst b/examples-docs/MVLinac/VRT_3.rst
@@ -0,0 +1,6 @@
+.. _example_linac_vrt3:
+
+VRT_3.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/VRT_3.txt
diff --git a/examples-docs/MVLinac/VRT_HD.rst b/examples-docs/MVLinac/VRT_HD.rst
@@ -0,0 +1,6 @@
+.. _example_linac_vrthd:
+
+VRT_HD.txt
+------------------------
+
+.. literalinclude:: /examples/MVLinac/VRT_HD.txt
diff --git a/examples-docs/MVLinac/index.rst b/examples-docs/MVLinac/index.rst
@@ -5,4 +5,26 @@ MVLinac
 	:maxdepth: 1
 
 	intro
+	Field
+	FixedTxHead
+	Flattener6MV
+	Flattener18MV
+	FullTxHeadField
+	Jaws
+	LinacDefaults
+	MLC
+	MainTxHead
+	Monitor
+	ScoreEnergyFluence
+	ScoreEnergySpectrum
+	ScorePhaseSpace
+	Target
+	TestComponent
+	VRT_1a
+	VRT_1b
+	VRT_2
+	VRT_3
+	VRT_HD
+	WaterBox
+	WaterPhantom
 
diff --git a/examples-docs/Optical/PixelatedDetector.rst b/examples-docs/Optical/PixelatedDetector.rst
@@ -0,0 +1,4 @@
+PixelatedDetector.txt
+-----------------------
+
+.. literalinclude:: /examples/Optical/PixelatedDetector.txt
diff --git a/examples-docs/Optical/index.rst b/examples-docs/Optical/index.rst
@@ -6,6 +6,7 @@ Optical
 
 	OpticalMaterialSample
 	OpticalPhotonCount
+	PixelatedDetector
 	PlasticScintillator
 	Rotating_Surfaces
 	Surfaces

diff --git a/examples-docs/Patient/.DS_Store b/examples-docs/Patient/.DS_Store
diff --git a/examples-docs/Patient/PatientInIEC_1.rst b/examples-docs/Patient/PatientInIEC_1.rst
@@ -0,0 +1,4 @@
+PatientInIEC_1.txt
+-----------------------
+
+.. literalinclude:: /examples/Patient/PatientInIEC_1.txt
diff --git a/examples-docs/Patient/PatientInIEC_2.rst b/examples-docs/Patient/PatientInIEC_2.rst
@@ -0,0 +1,4 @@
+PatientInIEC_2.txt
+-----------------------
+
+.. literalinclude:: /examples/Patient/PatientInIEC_2.txt
diff --git a/examples-docs/Patient/PatientInIEC_2_time_feature.rst b/examples-docs/Patient/PatientInIEC_2_time_feature.rst
@@ -0,0 +1,4 @@
+PatientInIEC_2_time_feature.txt
+-----------------------
+
+.. literalinclude:: /examples/Patient/PatientInIEC_2_time_feature.txt
diff --git a/examples-docs/Patient/PatientInIEC_3.rst b/examples-docs/Patient/PatientInIEC_3.rst
@@ -0,0 +1,4 @@
+PatientInIEC_3.txt
+-----------------------
+
+.. literalinclude:: /examples/Patient/PatientInIEC_3.txt
diff --git a/examples-docs/Patient/index.rst b/examples-docs/Patient/index.rst
@@ -10,6 +10,10 @@ Patient
 	HUtoMaterialSchneider
 	HUtoMaterialSchneider2
 	Implant
+	PatientInIEC_1
+	PatientInIEC_2_time_feature
+	PatientInIEC_2
+	PatientInIEC_3
 	TwoDicoms
 	ViewAbdomen_rtdose
 	ViewAbdomen

diff --git a/examples-docs/Scoring/OriginCount.rst b/examples-docs/Scoring/OriginCount.rst
@@ -0,0 +1,4 @@
+OriginCount.txt
+----------
+
+.. literalinclude:: /examples/Scoring/OriginCount.txt
diff --git a/examples-docs/Scoring/index.rst b/examples-docs/Scoring/index.rst
@@ -24,6 +24,7 @@ Scoring
 	Inactive
 	Ion
 	Origin
+	OriginCount
 	ParallelBoxRebinned
 	SplitByTimeFeature
 	Surfaces

diff --git a/examples-docs/SpecialComponents/Jaws.rst b/examples-docs/SpecialComponents/Jaws.rst
diff --git a/examples-docs/TimeFeature/RasterScanOnMovingTarget.rst b/examples-docs/TimeFeature/RasterScanOnMovingTarget.rst
@@ -0,0 +1,4 @@
+RasterScanOnMovingTarget.txt
+-----------------------
+
+.. literalinclude:: /examples/TimeFeature/RasterScanOnMovingTarget.txt
diff --git a/examples-docs/TimeFeature/RotatingCylinderWithPhiCut.rst b/examples-docs/TimeFeature/RotatingCylinderWithPhiCut.rst
@@ -0,0 +1,4 @@
+RotatingCylinderWithPhiCut.txt
+-----------------------
+
+.. literalinclude:: /examples/TimeFeature/RotatingCylinderWithPhiCut.txt
diff --git a/examples-docs/TimeFeature/index.rst b/examples-docs/TimeFeature/index.rst
@@ -11,7 +11,9 @@ TimeFeature
 	CylinderGrowingInPhi
 	Darkening
 	Logo
+	RasterScanOnMovingTarget
 	RotateResizeRecolor
+	RotatingCylinderWithPhiCut
 	Rotation
 	RunRandom_Mode
 	RunSequential_Mode
diff --git a/examples/Nozzle/NbParticlesInTime.txt b/examples/Nozzle/NbParticlesInTime.txt