Contents Menu Expand Light mode Dark mode Auto light/dark mode
TOPAS
Logo

Getting Started

  • Installation
    • QuickStart Guide for MacOS
    • QuickStart Guide for Debian
    • QuickStart Guide for WSL
  • Authors and Funding
  • Citation
  • User Support and Contributions
  • Geant4 Version

Simulation Control

  • Parameter Control System
    • Design Philosophy
    • Syntax
    • Syntax highlighting
    • Relative Parameters
    • Hierarchical Control
    • Controlling Multiple Batch Jobs
  • Default Parameters
  • Overall Control
    • Time mode
    • Multithreading
    • Random Number Seed
    • Set run duration based on statistical goals
    • Miscellaneous
  • Materials
  • Geometry Components
    • Introduction
    • Placement of Components
    • Parallel Worlds
    • Electromagnetic Fields
    • Visualization Attributes
    • Dividable Components
    • Generic Components
    • Group Component
    • Specialized Components
    • Patient Components
  • Particle Sources
    • Introduction
    • Beam Sources
    • Distributed Source
    • Emittance Sources
    • Environment Source
    • Isotropic Sources
    • Volumetric Source
    • Phase Space Sources
    • Miscellaneous
  • Physics
    • Introduction
    • Modular Physics Lists
    • Reference Physics Lists
    • Optical Physics
    • Miscellaneous
  • Scoring
    • Introduction
    • Volume Scorers
    • Surface Scorers
    • Phase Space Scorer
    • Filtering Scorers
    • Output Specification
    • Statistical Information
    • Miscellaneous
  • Graphics
  • Time Features
  • Variance Reduction
    • Introduction
    • Geometrical Particle Splitting
    • Importance Sampling
    • Weight Window
    • Tracking Only Specific Particles
    • Secondary Biasing
    • Forced interaction
    • Periodic Boundary Condition
    • Cross section enhancement
  • Outcome Modeling
  • TOPAS Graphical User Interface
  • Parameter Optimization
  • IEC: LINAC Treatment Head Simulation

Example Parameter Files

  • Basic
    • AllParameterForms.txt
    • BatchJob1.txt
    • BatchJob2.txt
    • BatchJobShared.txt
    • BoxRotatedAroundItsCorner.txt
    • DistributedSourcePointsInShell.txt
    • DistributedSourcePointsInSphereGaussian.txt
    • DistributedSourcePointsInSphere.txt
    • DistributedSourcePointsInTwistedTubs.txt
    • DividedComponents.txt
    • DNAModelByRegions.txt
    • Emittance_Gaussian.txt
    • Emittance_Twiss.txt
    • EmModelByRegions.txt
    • EnvironmentSource.txt
    • ExtraSequence1.txt
    • ExtraSequence2.txt
    • ExtraSequences.txt
    • FlatteningFilter.txt
    • Isotope.txt
    • LayeredMassGeometry.txt
    • OneBox.txt
    • OneBoxRotate.txt
    • OneBoxTranslate.txt
    • ParallelWorlds.txt
    • ParticleSourcesFromGroup.txt
    • PhysicsSetting.txt
    • QtShapeTest.txt
    • ShapeTestWithAllParameters.txt
    • ShapeTestWithOnlyRequiredParameters.txt
    • Spectrum.txt
    • TwoBeams.txt
    • VolumetricSource.txt
    • VoxelMaterialsInDividedComponents.txt
  • Brachytherapy
    • Brachytherapy package for TOPAS
    • DoseTLE.txt
    • HDRSource.txt
    • HDRSourceInApplicator.txt
    • Ir192_Flexisource.txt
    • Ir192_MicroSelectronV2.txt
    • Ir192_TG186.txt
    • TG186Applicator.txt
    • LDRSource.txt
    • Cs131_IsoRay-CS-1-Rev2.txt
    • I125_BardSTM1251.txt
    • I125_Best2301.txt
    • I125_IsoAid_IAI-125A.txt
    • I125_OncoSeed6711.txt
    • I125_SelectSeed.txt
    • I125_SL-125.txt
    • I125_Theragenic-AgX100.txt
    • Pd103_Best2335.txt
    • Pd103_IAPd103A.txt
    • Pd103_Theraseed200Heavy.txt
    • Pd103_Theraseed200Light.txt
    • EyeModel.txt
    • COMSEyePlaque.txt
  • Graphics
    • ColorByCharge.txt
    • ColorByCreatorProcess.txt
    • ColorByEnergy.txt
    • ColorByGeneration.txt
    • ColorByMomentum.txt
    • ColorByOriginComponent.txt
    • ColorByOriginComponentOrSubComponent.txt
    • ColorByOriginVolume.txt
    • ColorByParticleType.txt
    • ColorTest.txt
    • FilterByCreatorProcess.txt
    • FilterByEnergy.txt
    • FilterByMomentum.txt
    • FilterByOriginComponent.txt
    • FilterByOriginComponentOrSubComponent.txt
    • FilterByOriginVolume.txt
    • FilterByParticleCharge.txt
    • FilterByParticleType.txt
    • NanoMeterScaleTest.txt
    • ParticleFlight.txt
    • QtTest.txt
    • SolidSphere.txt
    • TestGraphics.txt
    • TwoProjections.txt
  • MVLinac
    • IEC: LINAC Treatment Head Simulation
    • Field.txt
    • FixedTxHead.txt
    • Flattener6MV.txt
    • Flattener18MV.txt
    • FullTxHeadField.txt
    • Jaws.txt
    • LinacDefaults.txt
    • MLC.txt
    • MainTxHead.txt
    • Monitor.txt
    • ScoreEnergyFluence.txt
    • ScoreEnergySpectrum.txt
    • ScorePhaseSpace.txt
    • Target.txt
    • TestComponent.txt
    • VRT_1b.txt
    • VRT_2.txt
    • VRT_3.txt
    • VRT_HD.txt
    • WaterBox.txt
    • WaterPhantom.txt
  • Nozzle
    • ConstantsForNozzles.txt
    • RasterScanningPattern.txt
    • ScanningNozzle.txt
    • ScanningStationaryTarget.txt
    • ScanningTargetMovingHorizontal.txt
    • ScanningTargetMovingInDepth.txt
    • ScatteringNozzle.txt
    • ScatteringNozzle_QtTest.txt
    • ScatteringNozzle_run.txt
    • ScatteringNozzle_run_QtTest.txt
    • TargetInWaterPhantom.txt
    • TsAnalysisWaterPhantom.txt
    • Viewer.txt
  • Optical
    • OpticalMaterialSample.txt
    • OpticalPhotonCount.txt
    • PixelatedDetector.txt
    • PlasticScintillator.txt
    • Rotating_Surfaces.txt
    • Surfaces.txt
    • WavelengthShifter.txt
  • Outcome
    • CEModelBurman.txt
    • CVModelStavrev.txt
    • LKMModelBurman.txt
    • Phantom.txt
    • PoissonModelOkuneff.txt
    • TestOutcomeModel.txt
    • TestRestoreModel.txt
  • Patient
    • Applicator.txt
    • DicomCutaway.txt
    • DoseTo4DCT.txt
    • DoseToCT.txt
    • HUtoMaterialSchneider.txt
    • HUtoMaterialSchneider2.txt
    • Implant.txt
    • PatientInIEC_1.txt
    • PatientInIEC_2_time_feature.txt
    • PatientInIEC_2.txt
    • PatientInIEC_3.txt
    • TwoDicoms.txt
    • ViewAbdomen_rtdose.txt
    • ViewAbdomen.txt
    • XCAT_Materials.txt
    • XCAT.txt
  • PhaseSpace
    • MultiRun_Write_ASCII.txt
    • ReadASCII.txt
    • ReadBinary.txt
    • ReadLimited.txt
    • ReadElekta.txt
    • ReadVarian.txt
    • WriteASCII.txt
    • WriteBinary.txt
    • WriteIonsASCII.txt
    • WriteLimited.txt
    • WriteROOT.txt
  • Scoring
    • ChargeInSphere.txt
    • Complex.txt
    • DepthDose.txt
    • Dose.txt
    • DoseInVoxelMaterials.txt
    • DoseToMediumVsWater.txt
    • DoseVolumeHistogram.txt
    • EnergyAndDose.txt
    • EnergyDepositBinnedByEnergy.txt
    • EnergyDivisions.txt
    • EnergyInBinnedCylinder.txt
    • FilterByInteractionCount.txt
    • Filters.txt
    • FoilToBox.txt
    • FoilToCylinder.txt
    • FoilToSphere.txt
    • Gated.txt
    • GeometryDivisions.txt
    • Histograms.txt
    • Inactive.txt
    • Ion.txt
    • Origin.txt
    • OriginCount.txt
    • ParallelBoxRebinned.txt
    • SparsifyAndSingleIndex.txt
    • SplitByTimeFeature.txt
    • Surfaces.txt
    • VoxelMaterials.txt
  • SpecialComponents
    • CAD.txt
    • DipoleMagnet.txt
    • MultiLeafCollimator.txt
    • MultiLeafCollimator_sequence.txt
    • MultiWire_Chamber.txt
    • Propeller_ContinuousRotation.txt
    • Propeller_StepRotation.txt
    • Propeller.txt
    • PurgingMagnet_move.txt
    • QuadAndDipoleMagnets.txt
    • QuadInMovingNozzle.txt
    • QuadrupoleMagnet.txt
    • RangeModulator_ConstantBeam.txt
    • RangeModulator_CurrentModulatedBeam.txt
    • RangeModulator.txt
    • RidgeFilter.txt
    • RotatingMagnet.txt
    • UniformElectroMagneticField.txt
  • TimeFeature
    • BoxWithinBox.txt
    • CameraRotateAndZoom.txt
    • ChangingKEFilterByTimeFeature.txt
    • ColorChange.txt
    • CylinderGrowingInPhi.txt
    • Darkening.txt
    • Logo.txt
    • RasterScanOnMovingTarget.txt
    • RotateResizeRecolor.txt
    • RotatingCylinderWithPhiCut.txt
    • Rotation.txt
    • RunRandom_Mode.txt
    • RunSequential_Mode.txt
  • UCSFETF
    • UCSF_Beamline_Base.txt
    • UCSF_Beamline_Propeller10.txt
    • UCSF_Beamline_Propeller15.txt
    • UCSF_Beamline_Propeller20.txt
    • UCSF_Beamline_Propeller24.txt
    • UCSF_DefaultParameters.txt
    • UCSF_WaterPhantom.txt
    • User_Beamline_WC_Viewer.txt
    • User_BP_R28_WaterPhantom.txt
    • User_SOBP24_R28_WaterPhantom.txt
    • User_SOBP24_Viewer.txt
    • Viewer.txt
  • VarianceReduction
    • AmbientDoseEquivalent.txt
    • CrossSectionEnhancement.txt
    • ForcedInteraction.txt
    • GeometricalParticleSplit.txt
    • ImportanceSampling.txt
    • ImportanceSamplingMassGeometry.txt
    • ImportanceSamplingSecondaryBiasing.txt
    • SecondaryBiasing.txt
    • WeightWindow.txt

How to Extend OpenTOPAS

  • Introduction to Extensions
  • Custom Geometry Components
  • Custom Particle Sources
  • Custom Physics Lists and Physics Modules
  • Custom Scorers
  • Custom Outcome Models
  • Custom Filters
  • Custom Fields
  • Custom Imaging to Material Conversion
  • Additional User Hooks

Provided Extensions

  • Proton RBE Scorers
  • Imaging Extension
    • Detector Geometries
    • Scorers
    • CBCT Example
    • PET Example
  • Microdosimetry Extension
Back to top
Edit this page

Attention

** Sign up for TOPAS Announcements Email List**
Get updates on user meetings, code releases, and more.
For more, see https://github.com/OpenTOPAS/OpenTOPAS/discussions/185

Parameter Control System#

  • Design Philosophy
  • Syntax
    • Complete Set of Allowed Syntax for any one Parameter Line
  • Syntax highlighting
  • Relative Parameters
  • Hierarchical Control
    • Parameter File Chains
    • Parameter File Graphs
  • Controlling Multiple Batch Jobs
Next
Design Philosophy
Previous
Geant4 Version
Copyright © 2025 The TOPAS Collaboration
Made with Sphinx and @pradyunsg's Furo