From a0189d3ca6b55a8ea82cd46edc6673e5d4dec65c Mon Sep 17 00:00:00 2001 From: Anthony LaTorre Date: Sat, 3 Sep 2011 13:15:15 -0400 Subject: add intro to sphinx documentation from the bitbucket wiki and add some entries to the table of contents. --- doc/source/index.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index bd62c12..5ae0e5d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,11 +6,21 @@ Welcome to chroma's documentation! ================================== +Chroma is a high performance optical photon simulation for particle physics detectors. It tracks individual photons passing through a triangle-mesh detector geometry, simulating standard physics processes like diffuse and specular reflections, refraction, Rayleigh scattering and absorption. + +With the assistance of a CUDA-enabled GPU, Chroma can propagate 2.5 million photons per second in a detector with 29,000 photomultiplier tubes. This is 200x faster than the same simulation with GEANT4. + Contents: .. toctree:: :maxdepth: 2 + install + geometry + render + simulation + likelihood + Indices and tables ================== -- cgit