diff --git a/Main_example.py b/ExampleTransients.py similarity index 100% rename from Main_example.py rename to ExampleTransients.py diff --git a/README.md b/README.md index 482884d8a7b4005cecb78ee5a69475b22227baa9..63a5dfe2b7a7916b4e22c5b4b26c823c6d6316da 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # LightSimtastic -A silicon photomultiplier simulation package written in Python. The program can produce discharge arrays, charge spectra and sample transients. \ No newline at end of file +A Silicon Photo-Multiplier simulation package written in Python. This program can be used to simulate primary Geiger discharges and generate correlated Geiger discharges due to prompt and delayed cross-talk and after-pulses. + +A number of different physics-based models and statistical treatments for the simulation of correlated Geiger discharges can be selected. Inputs to the program are the mean number and the time distribution of Geiger discharges from photons, as well as the dark-count rate. + +By simulating many events, charge spectra - as measured by a current-integrating charge-to-digital converter - can be produced. In addition, current transients convolved with electronics response functions, as recorded by a digital oscilloscope, and time-difference distributions can be simulated. + + + +To get started, have a look at ```Example.py``` as well as ```ExampleTransients.py```. + + +## References + +E. Garutti, R. Klanner, J. Rolph, J. Schwandt: _Simulation of the response of SiPMs; Part I: Without saturation effects_. [doi.org/10.1016/j.nima.2021.165853](https://doi.org/10.1016/j.nima.2023.168544) diff --git a/lightsimtastic_logo.png b/lightsimtastic_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..94356985f5e3bc92b7f48a63f5d109e453fe757e Binary files /dev/null and b/lightsimtastic_logo.png differ