summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
blob: 8b8f6943083da030ad6ed59266d4e3ba43444855 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.. chroma documentation master file, created by
   sphinx-quickstart on Sat Sep  3 12:36:34 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Chroma: Ultra-fast Photon Monte Carlo
=====================================

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.

Development
-----------

Chroma is under heavy development.  Tagged releases will happen soon,
but in the meantime we encourage people to obtain the code directly
from the Mercurial repository hosted at Bitbucket:

  http://bitbucket.org/chroma/chroma

For questions, ideas, and discussion, join the Chroma development mailing list:

  http://groups.google.com/group/chroma-sim

For bug reports, please create a Bitbucket account and use the Bitbucket issue tracker:

  https://bitbucket.org/chroma/chroma/issues?status=new&status=open


Documentation
-------------

The core concepts are described in the :download:`Chroma whitepaper
<chroma.pdf>`.

The software documentation is evolving rapidly, so
many of the following sections are incomplete at the moment.
Subscribe to the mailing list for update announcements!

.. toctree::
   :maxdepth: 2

   install
   tour
   geometry
   detector
   render
   simulation
   likelihood

Authors
-------

Chroma is developed by Anthony LaTorre and `Stan Seibert
<mailto:sseibert@hep.upenn.edu>`_. Chroma contains some material
properties found in the `WCSim application
<https://wiki.bnl.gov/dusel/index.php/WCSim>`_.

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`