diff options
| author | Anthony LaTorre <tlatorre9@gmail.com> | 2011-09-03 13:15:15 -0400 |
|---|---|---|
| committer | Anthony LaTorre <tlatorre9@gmail.com> | 2011-09-03 13:15:15 -0400 |
| commit | a0189d3ca6b55a8ea82cd46edc6673e5d4dec65c (patch) | |
| tree | 6c5fccfa174f6c812ba8605b39ed4a28ccfc4cbe /doc | |
| parent | 5edb92558eb1b8ea9d920f8b006f453b5f1a89d6 (diff) | |
| download | chroma-a0189d3ca6b55a8ea82cd46edc6673e5d4dec65c.tar.gz chroma-a0189d3ca6b55a8ea82cd46edc6673e5d4dec65c.tar.bz2 chroma-a0189d3ca6b55a8ea82cd46edc6673e5d4dec65c.zip | |
add intro to sphinx documentation from the bitbucket wiki and add some entries to the table of contents.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/geometry.rst | 2 | ||||
| -rw-r--r-- | doc/source/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/install.rst | 2 | ||||
| -rw-r--r-- | doc/source/likelihood.rst | 2 | ||||
| -rw-r--r-- | doc/source/render.rst | 2 | ||||
| -rw-r--r-- | doc/source/simulation.rst | 2 |
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 +========================== |