TDCRPy 0.0.6__tar.gz → 0.0.8__tar.gz

{TDCRPy-0.0.6 → TDCRPy-0.0.8}/Code/TDCRPy.py

@@ -9,7 +9,7 @@ Bureau International des Poids et Mesures
 """
 
 ## IMPORT PYTHON MODULES
-import TDCR_model_lib as tl
+import TDCRPy.TDCR_model_lib as tl
 import numpy as np
 
 def TDCRPy(L, TD, TAB, TBC, TAC, Rad, pmf_1, N, kB, RHO, nE, mode, mode2, Display=False):
@@ -296,7 +296,7 @@ def TDCRPy(L, TD, TAB, TBC, TAC, Rad, pmf_1, N, kB, RHO, nE, mode, mode2, Displa
                 energy_vec.append(511)
 
             if p == "gamma" or p == "XKA" or p == "XKB" or p == "XL":
-                energy_vec[i] = tl.energie_dep_gamma(energy_vec[i])          # sampling energy free from photon
+                energy_vec[i] = tl.energie_dep_gamma(energy_vec[i],v=10)          # sampling energy free from photon
                 particle_vec[i] = "electron"
             if p == "Auger K" or p == "Auger L":
                 particle_vec[i] = "electron"

{TDCRPy-0.0.6 → TDCRPy-0.0.8}/Code/TDCR_model_lib.py

@@ -1266,14 +1266,18 @@ def E_quench_a(e,kB,nE):
 #========================= énergie gamma ===================================================
 #'''
 if absolutePath: 
-    fp1 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_p_1_200k.txt'       #gamma-10ml-1-200keV-niveau 0
-    fp2 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_p_200_2000k.txt'    #gamma-10ml-200-2000keV-niveau 0
-    fp3 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_p_2000_10000k.txt'  #gamma-10ml-2000-10000keV-niveau 0
+    fp1 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_1_200k.txt'       #gamma-10ml-1-200keV-niveau 0
+    fp2 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_200_2000k.txt'    #gamma-10ml-200-2000keV-niveau 0
+    fp3 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_2000_10000k.txt'  #gamma-10ml-2000-10000keV-niveau 0
+    fp4 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_16ml-photon_1_200k.txt'       #gamma-10ml-1-200keV-niveau 0
+    fp5 = 'G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/matrice_16ml-photon_200_2000k.txt'       #gamma-10ml-1-200keV-niveau 0
     fe = "G:\Python_modules\Jialin\Code\\MCNP-MATRIX/matrice/fichier/E_depose.txt"  
 else:
-    fp1 = 'MCNP-MATRIX/matrice/fichier/matrice_p_1_200k.txt'      #gamma-10ml-1-200keV-niveau 0
-    fp2 = 'MCNP-MATRIX/matrice/fichier/matrice_p_200_2000k.txt'   #gamma-10ml-200-2000keV-niveau 0
-    fp3 = 'MCNP-MATRIX/matrice/fichier/matrice_p_2000_10000k.txt' #gamma-10ml-2000-10000keV-niveau 0
+    fp1 = 'MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_1_200k.txt'      #gamma-10ml-1-200keV-niveau 0
+    fp2 = 'MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_200_2000k.txt'   #gamma-10ml-200-2000keV-niveau 0
+    fp3 = 'MCNP-MATRIX/matrice/fichier/matrice_10ml-photon_2000_10000k.txt' #gamma-10ml-2000-10000keV-niveau 0
+    fp4 = 'MCNP-MATRIX/matrice/fichier/matrice_16ml-photon_1_200k.txt'      #gamma-10ml-1-200keV-niveau 0
+    fp5 = 'MCNP-MATRIX/matrice/fichier/matrice_16ml-photon_200_2000k.txt'      #gamma-10ml-1-200keV-niveau 0
     fe = "MCNP-MATRIX/matrice/fichier/E_depose.txt"
 '''
 data1 = f1.readlines()
@@ -1329,9 +1333,11 @@ def read_matrice(path,niveau):
 Matrice10_p_1 = read_matrice(fp1,0)
 Matrice10_p_2 = read_matrice(fp2,1)
 Matrice10_p_3 = read_matrice(fp3,2)
+Matrice16_p_1 = read_matrice(fp4,0)
+Matrice16_p_2 = read_matrice(fp5,1)
 Matrice_e = read_matrice(fe,'e')
 
-def energie_dep_gamma(e_inci,*,matrice10_1=Matrice10_p_1,matrice10_2=Matrice10_p_2,matrice10_3=Matrice10_p_3,ed=Matrice_e):
+def energie_dep_gamma(e_inci,v,matrice10_1=Matrice10_p_1,matrice10_2=Matrice10_p_2,matrice10_3=Matrice10_p_3,matrice16_1=Matrice16_p_1,matrice16_2=Matrice16_p_2,ed=Matrice_e):
     """ 
     ----------
     Parameters
@@ -1357,16 +1363,19 @@ def energie_dep_gamma(e_inci,*,matrice10_1=Matrice10_p_1,matrice10_2=Matrice10_p
     """
     ## sort keV / entrée : keV
     if e_inci <= 200:
-        index = int(e_inci)            # index de colonne de la matrice de l'énergie incidente la plus proche 
-        #doc = 'MCNP-MATRIX/matrice/matrice_p_1_200k.txt'
-        matrice = matrice1
-        #taille_x = 200
+        index = int(e_inci)            # index de colonne de la matrice de l'énergie incidente la plus proche
+        if v == 10: 
+            matrice = matrice10_1
+        elif v == 16:
+            matrice = matrice16_1
         e = ed[:,0]
     
     elif e_inci <= 2000:
         index = int((e_inci-200)/2)
-        #doc = 'MCNP-MATRIX/matrice/matrice_p_200_2000k.txt'
-        matrice = matrice2
+        if v == 10: 
+            matrice = matrice10_2
+        elif v == 16:
+            matrice = matrice16_2
         #taille_x = 901
         e = ed[:,1]
 
@@ -1395,8 +1404,8 @@ def energie_dep_gamma(e_inci,*,matrice10_1=Matrice10_p_1,matrice10_2=Matrice10_p
     if result  > e_inci: result = e_inci
     return result
 
-#for i in range(50):
-    #print(energie_dep_gamma(511))
+#for i in range(10):
+ #   print(energie_dep_gamma(511,16))
 
 
 if absolutePath: 

{TDCRPy-0.0.6 → TDCRPy-0.0.8}/Code/test.py

@@ -7,3 +7,6 @@ Created on Thu Jul 13 19:15:23 2023
 import TDCRPy
 
 TDCRPy.TDCRPy(1, 0.5, 0.5, 0.5, 0.5, "H-3", "1", 10, 0.00001, 1,10, "eff", "sym", Display=True)
+
+
+TDCRPy.TDCRPy(L, TD, TAB, TBC, TAC, Rad, pmf_1, N, kB, RHO, nE, mode, mode2)

TDCRPy-0.0.8/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: TDCRPy
+Version: 0.0.8
+Summary: TDCR model
+Home-page: https://github.com/RomainCoulon/TDCRPy
+Author: RomainCoulon (Romain Coulon)
+Author-email: <romain.coulon@bipm.org>
+License: UNKNOWN
+Keywords: python,TDCR,Monte-Carlo,radionuclide,scintillation,counting
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Natural Language :: French
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Scientific/Engineering :: Physics
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+
+# TDCRPy
+
+TDCRPy is a Python code to calculate detection efficiency of a liquide scintillation counter using 3-photomultiplier tubes.
+The calculation is based on the photo-physical model called of the Triple-to-Double-Coincidence-Ratio method (TDCR) [[1]](#1) and a Monte-Carlo sampling allowing to adress complexe decay schemes and radionuclide mixtures. The process is summarized in the figure below.
+
+<img src="./FlowChart.jpg" alt="drawing" width="500"/>
+
+## Nuclear decay 
+
+The code directly reads decay data from the Decay Data Evaluation Project (DDEP) web interface [[2]](#2) that is recommanded to be used by the radionuclide metrology community. The PenNuc format [[3]](#3) is used to simulate decays and the $\beta$ spectra from the BetaShape code [[4]](#4) are used. The BetaShape code estimates accurate $\beta$ spectra by taking the atomic exchange effect and also simulate accurately electron capture decay [[5]](#5). It has been demonstrated to offer significant improvement in the context of liquid scintillation counting [[6]](#6).
+
+## Atomic relaxation
+
+The atomic relaxation from missing electrons in the inner-shell following electron capture and internal conversion is simulated by ENSDF data on the DDEP web interface. 
+
+## Interaction
+
+The interaction of $\gamma$ rays, electrons and positrons are simulated using response kernels calculated by the Monte-Carlo code MCNP6 developped by Los Alamos [[13]](#13). 
+
+## Scintillation
+
+The stopping power of electrons between 20 keV and 1000 keV is a mixture of a radiative loss model [[7]](#7) and a collision model [[8]](#8) that has been validated agaisnt the NIST model ESTAR [[9]](#9) recommanded by the ICRU Report 37 [[10]](#10). At low energy - between 10 eV and 20 keV - the model from Tan and Xia [[11]](#11) is implemented.
+
+The stopping power of $\alpha$ particles of energy comprises between 1 keV and 8 MeV comes from the NIST code ASTAR [[9]](#9) recommanded in the ICRU Report 49 [[12]](#12). For energy below 1 keV, an extrapolation is made.
+
+## Statistical model
+
+...
+
+## References
+
+<a id="1">[1]</a> Ryszard Broda, Krzysztof Pochwalski, Tomasz Radoszewski, Calculation of liquid-scintillation detector efficiency, *Applied Radiation and Isotopes* **39**:2, 1988, 159-164, https://doi.org/10.1016/0883-2889(88)90161-X
+
+<b id="2">[2]</b> http://www.lnhb.fr/ddep_wg/
+
+<c id="3">[3]</c> E. García-Toraño, V. Peyres, F. Salvat, PenNuc: Monte Carlo simulation of the decay of radionuclides, *Computer Physics Communications* **245**, 2019, 106849 https://doi.org/10.1016/j.cpc.2019.08.002
+
+<c id="4">[4]</c> X. Mougeot, Erratum: Reliability of usual assumptions in the calculation of $\beta$ and $\bar{\mu}$ spectra, *Physical Review C* **91**, 2015, 055504, https://doi.org/10.1103/PhysRevC.92.059902
+
+<c id="5">[5]</c> X. Mougeot, Towards high-precision calculation of electron capture decays, *Applied Radiation and Isotopes* **154**, 2019, 108884,  https://doi.org/10.1016/j.apradiso.2019.108884
+
+<c id="6">[6]</c> K. Kossert, X. Mougeot, Improved activity standardization of <sup>90</sup>Sr/<sup>90</sup>Y by means of liquid scintillation counting, *Applied Radiation and Isotopes* **168**, 2021, 109478, https://doi.org/10.1016/j.apradiso.2020.109478
+
+<c id="7">[7]</c> S.M. Seltzer, M.R. Berger, M. R., Evaluation of the collision stopping power of elements and compounds for electrons and positrons, *Applied Radiation and Isotopes* **33**:11, 1982, 1189-1218, https://doi.org/10.1016/0020-708x(82)90244-7
+
+<c id="8">[8]</c> M.O. El-Ghossain, Calculations Of Stopping Power, And Range Of Electrons Interaction With Different Material And Human Body Parts, *International Journal of Scientific & Technology Research* **6**:1 2017. https://www.ijstr.org/final-print/jan2017/Calculations-Of-Stopping-Power-And-Range-Of-Electrons-Interaction-With-Different-Material-And-Human-Body-Parts.pdf
+
+<c id="9">[9]</c> M.J. Berger, J.S. Coursey, M.A. Zucker and J. Chang,Stopping-Power & Range Tables for Electrons, Protons, and Helium Ions, *NIST Standard Reference Database 124*, 2017, https://dx.doi.org/10.18434/T4NC7P
+
+<c id="10">[10]</c> ICRU Report 37, *Stopping Powers for Electrons and Positrons*
+
+<c id="11">[11]</c> Z. Tan, Y. Xia, Stopping power and mean free path for low-energy electrons in ten scintillators over energy range of 20–20,000 eV, *Applied Radiation and Isotopes* **70**, 2012, 296-300, https://doi.org/10.1016/j.apradiso.2011.08.012
+
+<c id="12">[12]</c> ICRU Report 49, *Stopping Power and Ranges for Protons and Alpha Particles*, https://www.icru.org/report/stopping-power-and-ranges-for-protons-and-alpha-particles-report-49/
+
+<c id="13">[13]</c> https://mcnp.lanl.gov/
+
+

TDCRPy-0.0.8/TDCRPy.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: TDCRPy
+Version: 0.0.8
+Summary: TDCR model
+Home-page: https://github.com/RomainCoulon/TDCRPy
+Author: RomainCoulon (Romain Coulon)
+Author-email: <romain.coulon@bipm.org>
+License: UNKNOWN
+Keywords: python,TDCR,Monte-Carlo,radionuclide,scintillation,counting
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Natural Language :: French
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Scientific/Engineering :: Physics
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+
+# TDCRPy
+
+TDCRPy is a Python code to calculate detection efficiency of a liquide scintillation counter using 3-photomultiplier tubes.
+The calculation is based on the photo-physical model called of the Triple-to-Double-Coincidence-Ratio method (TDCR) [[1]](#1) and a Monte-Carlo sampling allowing to adress complexe decay schemes and radionuclide mixtures. The process is summarized in the figure below.
+
+<img src="./FlowChart.jpg" alt="drawing" width="500"/>
+
+## Nuclear decay 
+
+The code directly reads decay data from the Decay Data Evaluation Project (DDEP) web interface [[2]](#2) that is recommanded to be used by the radionuclide metrology community. The PenNuc format [[3]](#3) is used to simulate decays and the $\beta$ spectra from the BetaShape code [[4]](#4) are used. The BetaShape code estimates accurate $\beta$ spectra by taking the atomic exchange effect and also simulate accurately electron capture decay [[5]](#5). It has been demonstrated to offer significant improvement in the context of liquid scintillation counting [[6]](#6).
+
+## Atomic relaxation
+
+The atomic relaxation from missing electrons in the inner-shell following electron capture and internal conversion is simulated by ENSDF data on the DDEP web interface. 
+
+## Interaction
+
+The interaction of $\gamma$ rays, electrons and positrons are simulated using response kernels calculated by the Monte-Carlo code MCNP6 developped by Los Alamos [[13]](#13). 
+
+## Scintillation
+
+The stopping power of electrons between 20 keV and 1000 keV is a mixture of a radiative loss model [[7]](#7) and a collision model [[8]](#8) that has been validated agaisnt the NIST model ESTAR [[9]](#9) recommanded by the ICRU Report 37 [[10]](#10). At low energy - between 10 eV and 20 keV - the model from Tan and Xia [[11]](#11) is implemented.
+
+The stopping power of $\alpha$ particles of energy comprises between 1 keV and 8 MeV comes from the NIST code ASTAR [[9]](#9) recommanded in the ICRU Report 49 [[12]](#12). For energy below 1 keV, an extrapolation is made.
+
+## Statistical model
+
+...
+
+## References
+
+<a id="1">[1]</a> Ryszard Broda, Krzysztof Pochwalski, Tomasz Radoszewski, Calculation of liquid-scintillation detector efficiency, *Applied Radiation and Isotopes* **39**:2, 1988, 159-164, https://doi.org/10.1016/0883-2889(88)90161-X
+
+<b id="2">[2]</b> http://www.lnhb.fr/ddep_wg/
+
+<c id="3">[3]</c> E. García-Toraño, V. Peyres, F. Salvat, PenNuc: Monte Carlo simulation of the decay of radionuclides, *Computer Physics Communications* **245**, 2019, 106849 https://doi.org/10.1016/j.cpc.2019.08.002
+
+<c id="4">[4]</c> X. Mougeot, Erratum: Reliability of usual assumptions in the calculation of $\beta$ and $\bar{\mu}$ spectra, *Physical Review C* **91**, 2015, 055504, https://doi.org/10.1103/PhysRevC.92.059902
+
+<c id="5">[5]</c> X. Mougeot, Towards high-precision calculation of electron capture decays, *Applied Radiation and Isotopes* **154**, 2019, 108884,  https://doi.org/10.1016/j.apradiso.2019.108884
+
+<c id="6">[6]</c> K. Kossert, X. Mougeot, Improved activity standardization of <sup>90</sup>Sr/<sup>90</sup>Y by means of liquid scintillation counting, *Applied Radiation and Isotopes* **168**, 2021, 109478, https://doi.org/10.1016/j.apradiso.2020.109478
+
+<c id="7">[7]</c> S.M. Seltzer, M.R. Berger, M. R., Evaluation of the collision stopping power of elements and compounds for electrons and positrons, *Applied Radiation and Isotopes* **33**:11, 1982, 1189-1218, https://doi.org/10.1016/0020-708x(82)90244-7
+
+<c id="8">[8]</c> M.O. El-Ghossain, Calculations Of Stopping Power, And Range Of Electrons Interaction With Different Material And Human Body Parts, *International Journal of Scientific & Technology Research* **6**:1 2017. https://www.ijstr.org/final-print/jan2017/Calculations-Of-Stopping-Power-And-Range-Of-Electrons-Interaction-With-Different-Material-And-Human-Body-Parts.pdf
+
+<c id="9">[9]</c> M.J. Berger, J.S. Coursey, M.A. Zucker and J. Chang,Stopping-Power & Range Tables for Electrons, Protons, and Helium Ions, *NIST Standard Reference Database 124*, 2017, https://dx.doi.org/10.18434/T4NC7P
+
+<c id="10">[10]</c> ICRU Report 37, *Stopping Powers for Electrons and Positrons*
+
+<c id="11">[11]</c> Z. Tan, Y. Xia, Stopping power and mean free path for low-energy electrons in ten scintillators over energy range of 20–20,000 eV, *Applied Radiation and Isotopes* **70**, 2012, 296-300, https://doi.org/10.1016/j.apradiso.2011.08.012
+
+<c id="12">[12]</c> ICRU Report 49, *Stopping Power and Ranges for Protons and Alpha Particles*, https://www.icru.org/report/stopping-power-and-ranges-for-protons-and-alpha-particles-report-49/
+
+<c id="13">[13]</c> https://mcnp.lanl.gov/
+
+

{TDCRPy-0.0.6 → TDCRPy-0.0.8}/setup.py

@@ -2,28 +2,34 @@ from setuptools import setup, find_packages
 import codecs
 import os
 
-VERSION = "0.0.6"
+VERSION = "0.0.8"
 DESCRIPTION = "TDCR model"
 
+with open("README.md", "r") as f:
+    long_description = f.read()
+
 setup(
     name = "TDCRPy",
     version = VERSION,
     author = "RomainCoulon (Romain Coulon)",
     author_email = "<romain.coulon@bipm.org>",
     description = DESCRIPTION,
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/RomainCoulon/TDCRPy",
     packages = find_packages(),
     install_requires = ["numpy","scipy","sys","time","urllib","zipfile","re"],
     keywords = ["python","TDCR","Monte-Carlo","radionuclide","scintillation","counting"],
     classifiers=[
         "Development Status :: 2 - Pre-Alpha",
         "Intended Audience :: Science/Research",
-		"License :: OSI Approved :: MIT License",
-		"Natural Language :: English",
-		"Natural Language :: French",
+	"License :: OSI Approved :: MIT License",
+	"Natural Language :: English",
+	"Natural Language :: French",
         "Programming Language :: Python :: 3",
         "Operating System :: Unix",
         "Operating System :: MacOS :: MacOS X",
         "Operating System :: Microsoft :: Windows",
-		"Topic :: Scientific/Engineering :: Physics",
+	"Topic :: Scientific/Engineering :: Physics",
     ]
 )

TDCRPy-0.0.6/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.1
-Name: TDCRPy
-Version: 0.0.6
-Summary: TDCR model
-Home-page: UNKNOWN
-Author: RomainCoulon (Romain Coulon)
-Author-email: <romain.coulon@bipm.org>
-License: UNKNOWN
-Keywords: python,TDCR,Monte-Carlo,radionuclide,scintillation,counting
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Natural Language :: French
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Topic :: Scientific/Engineering :: Physics
-License-File: LICENCE.md
-
-UNKNOWN
-

TDCRPy-0.0.6/TDCRPy.egg-info/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.1
-Name: TDCRPy
-Version: 0.0.6
-Summary: TDCR model
-Home-page: UNKNOWN
-Author: RomainCoulon (Romain Coulon)
-Author-email: <romain.coulon@bipm.org>
-License: UNKNOWN
-Keywords: python,TDCR,Monte-Carlo,radionuclide,scintillation,counting
-Platform: UNKNOWN
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Natural Language :: French
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Topic :: Scientific/Engineering :: Physics
-License-File: LICENCE.md
-
-UNKNOWN
-