summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/source/geometry.rst2
-rw-r--r--doc/source/index.rst10
-rw-r--r--doc/source/install.rst2
-rw-r--r--doc/source/likelihood.rst2
-rw-r--r--doc/source/render.rst2
-rw-r--r--doc/source/simulation.rst2
6 files changed, 20 insertions, 0 deletions
diff --git a/doc/source/geometry.rst b/doc/source/geometry.rst
new file mode 100644
index 0000000..bc5199d
--- /dev/null
+++ b/doc/source/geometry.rst
@@ -0,0 +1,2 @@
+Building a Geometry
+===================
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
==================
diff --git a/doc/source/install.rst b/doc/source/install.rst
new file mode 100644
index 0000000..11e4437
--- /dev/null
+++ b/doc/source/install.rst
@@ -0,0 +1,2 @@
+Installation
+============
diff --git a/doc/source/likelihood.rst b/doc/source/likelihood.rst
new file mode 100644
index 0000000..065d4bd
--- /dev/null
+++ b/doc/source/likelihood.rst
@@ -0,0 +1,2 @@
+Evaluating a Likelihood
+=======================
diff --git a/doc/source/render.rst b/doc/source/render.rst
new file mode 100644
index 0000000..297c083
--- /dev/null
+++ b/doc/source/render.rst
@@ -0,0 +1,2 @@
+Rendering Tools
+===============
diff --git a/doc/source/simulation.rst b/doc/source/simulation.rst
new file mode 100644
index 0000000..b18a263
--- /dev/null
+++ b/doc/source/simulation.rst
@@ -0,0 +1,2 @@
+Simulating Optical Photons
+==========================