Skip to content

Commit 7b35f9b

Browse files
authored
Update README.md
1 parent 2287b8a commit 7b35f9b

1 file changed

Lines changed: 27 additions & 15 deletions

File tree

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# pyDCONTINPALS
22
Copyright (c) 2020 Danny Petschke (danny.petschke@uni-wuerzburg.de). All rights reserved.<br><br>
33

4-
pyDCONTINPALS - A PYTHON program for running the historical FORTRAN code CONTIN-PALS initially provided by Provencher (1982) [1] and Gregory et al. (1990) [2,3]. CONTIN-PALS program solves Fredholm integral equations with convoluted exponential decays as kernels of the type that occur in the analysis of Positron Annihilation Lifetime Spectra (PALS).<br><br>
4+
pyDCONTINPALS - A Python program for running the historical FORTRAN code CONTIN-PALS initially provided by Provencher (1982) [1] and Gregory et al. (1990) [2,3]. CONTIN-PALS program solves Fredholm integral equations with convoluted exponential decays as kernels of the type that occur in the analysis of Positron Annihilation Lifetime Spectra (PALS).<br><br>
55

66
![demo](/demo.png)
77

88
# Quickstart Guide
99

10-
pyDCONTINPALS consists of 3 files ...
10+
`pyDCONTINPALS` consists of 3 files ...<br>
1111

12-
- pyDCONTINPALS.py
13-
- pyDCONTINPALSInput.py
14-
- pyDCONTINPALSSpecSimulator.py
12+
`pyDCONTINPALS.py`<br>
13+
`pyDCONTINPALSInput.py`<br>
14+
`pyDCONTINPALSSpecSimulator.py`<br>
1515

16-
1. edit (or leave it as it is) <b>pyDCONTINPALSInput.py </b>:
16+
1. <b>edit</b> (or leave it as it is) `pyDCONTINPALSInput.py`:
1717

1818
```python
1919
__demoMode = True # disable if running from real data
@@ -47,29 +47,41 @@ __channelResolutionInPs = 50.0 # >= 10 ... Note: this value is internally l
4747
__bkgrd_startIndex = 800;
4848
__bkgrd_count = 190; # number of channels with respect to the 'startIndex'
4949
```
50-
2. execute <b>pyDCONTINPALS.py</b> (note: all binaries must be placed into the same folder!)<br>
50+
2. <b>execute</b> `pyDCONTINPALS.py` (note: all binary files must be placed into the same folder!)<br>
5151

52-
3. finished. You should see the results as shown above in the figure if you are running in the demo mode <i>(__demoMode = True)</i>.
52+
3. <b>finished</b>. You should see the results as shown above in the figure when running in the demo mode <i>(__demoMode = True)</i>.
5353

5454
# How to cite this Program?
5555

5656
Before citing this program <b>pyDCONTINPALS</b> you need at least to cite the initial publication of the FORTRAN program <b>CONTIN-PALS</b> provided by Gregory et al. [2].
5757

5858
[R.B. Gregory, Y. Zhu, Analysis of positron annihilation lifetime data by numerical laplace inversion with the program CONTIN, Nucl. Instruments Methods Phys. Res. Sect. A Accel. Spectrometers, Detect. Assoc. Equip. 290 (1990) 172–182. doi:10.1016/0168-9002(90)90358-D.](https://doi.org/10.1016/0168-9002(90)90358-D).
5959

60-
You can cite all versions of pyDCONTINPALS by using the <b>DOI 10.5281/zenodo.3665474</b>. This DOI represents all versions, and will always resolve to the latest one.<br>
60+
```latex
61+
@article {Gregory1990,
62+
abstract = {The performance of the program CONTIN [Stephen W. Provencher, Comput. Phys. Commun. 27 (1982) 229], modified to solve Fredholm integral equations with convoluted kernels of the type that occur in the deconvolution and analysis of positron annihilation lifetime data, is investigated with computer-simulated test data. The method avoids direct determination of the instrument resolution function by employing the decay curve of a reference material with a well-known single lifetime. CONTIN employs a constrained, regularized least-squares analysis to calculate a continuous annihilation-rate probability density function (pdf) which is the most parsimonious solution that is consistent with the experimental data and prior knowledge. The performance of the algorithm for extracting positron annihilation lifetime information was evaluated by using several measures of the information content of the data described by Schrader and Usmar [in: Positron Annihilation Studies of Fluids, ed. S. Sharma (World Scientific, Singapore, 1988) p. 215]. The quality of the CONTIN reconstruction of the annihilation-rate pdf is strongly dependent on the information content of the data and is greatly improved as the total number of counts in the data set is increased. Nevertheless, the method provides excellent estimates of the intensities and mean lifetimes of peaks in the annihilation-rate pdf, even when the total counts in the data set are relatively low (105–106). The sensitivity of the algorithm to systematic errors in the data, including errors in the instrument resolution function, shifts in the positron of the zero-time channel of the sample and reference data and contamination of the reference decay by additional lifetime components was also evaluated. Errors in the FWHM of the instrument resolution function and shifts in the zero time channel as small as 110to15 of the channel width of the instrument generate additional spurious peaks in the annihilation-rate pdf and introduce errors in the lifetime parameters of the short-lived components.},
63+
author = {Gregory, Roger B. and Zhu, Yongkang},
64+
doi = {10.1016/0168-9002(90)90358-D},
65+
issn = {0168-9002},
66+
journal = {Nuclear Instruments and Methods in Physics Research Section A: Accelerators, Spectrometers, Detectors and Associated Equipment},
67+
month = {may},
68+
number = {1},
69+
pages = {172--182},
70+
publisher = {North-Holland},
71+
title = {{Analysis of positron annihilation lifetime data by numerical Laplace inversion with the program CONTIN}},
72+
url = {https://www.sciencedirect.com/science/article/pii/016890029090358D},
73+
volume = {290},
74+
year = {1990}
75+
}
76+
```
77+
78+
You can cite all versions of `pyDCONTINPALS` by using the <b>DOI 10.5281/zenodo.3665474</b>. This DOI represents all versions, and will always resolve to the latest one.<br>
6179

6280
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3665474.svg)](https://doi.org/10.5281/zenodo.3665475)
6381

6482
## v1.x
6583
pyDCONTINPALS v1.0:<br>[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3665475.svg)](https://doi.org/10.5281/zenodo.3665475)<br>
6684

67-
# Requirements
68-
- [NumPy](http://www.numpy.org/)
69-
- [matplotlib](https://matplotlib.org/)<br>
70-
71-
#### [WinPython x64](https://sourceforge.net/projects/winpython/) meets all requirements.
72-
7385
# License of pyDCONTINPALS (BSD-3-Clause)
7486

7587
Copyright (c) 2020 Danny Petschke (danny.petschke@uni-wuerzburg.de). All rights reserved.<br><br>

0 commit comments

Comments
 (0)