TDCRPy 0.0.46__py3-none-any.whl → 0.0.48__py3-none-any.whl

{TDCRPy-0.0.46.dist-info → TDCRPy-0.0.48.dist-info}/METADATA

@@ -1,13 +1,11 @@
 Metadata-Version: 2.1
 Name: TDCRPy
-Version: 0.0.46
+Version: 0.0.48
 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
@@ -25,7 +23,53 @@ Requires-Dist: numpy
 # 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.
+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 code is developped and maintained by the BIPM (MIT license).
+
+
+
+## Installation
+
+TDCRPy requires that the following packages are installed in your Python environement.
+
+```shell
+pip install importlib.resources
+pip install configparser
+pip install numpy
+pip install tqdm
+pip install setuptools
+pip install scipy
+```
+Then, TDCRPy can be installed.
+
+```shell
+pip install TDCRPy
+```
+
+To obtain the last version.
+
+```shell
+pip install TDCRPy --upgrade
+```
+
+The module can be imported in your Python code.
+
+```python
+import tdcrpy
+```
+
+## The function `TDCRPy()`
+
+This 
+
+
+
+
+
+
+
+The process is summarized in the figure below.
 
 <img src="./FlowChart.jpg" alt="drawing" width="500"/>
 
@@ -78,5 +122,3 @@ The stopping power of $\alpha$ particles of energy comprises between 1 keV and 8
 <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.46.dist-info → TDCRPy-0.0.48.dist-info}/RECORD

@@ -1,7 +1,7 @@
 tdcrpy/Activity_TDCR.py,sha256=wcllEOJbeEOexAYzcFGQx2luIBhxSU3LtpEalRmNziw,11530
 tdcrpy/EfficiencyProfils.py,sha256=-ZUPva1dU7lMRcKbQAewX9QyiTDwCiNQDoaQiw7dOI4,4829
-tdcrpy/TDCRPy.py,sha256=5y1XgcLzCInuK_NV78UiLWqAIwZbXlaigFiKw3w6tZU,26274
-tdcrpy/TDCR_model_lib.py,sha256=SctcE9lm6MOzMxE9Vr0rcjSaPzJZ-c7EA6Nwr_1_tKQ,48265
+tdcrpy/TDCRPy.py,sha256=5qx3z-kO3ekqQmmEWsfQCHuGjncVx2A8DL8BKxC0LnY,26134
+tdcrpy/TDCR_model_lib.py,sha256=MG1VsHa2J5tBahvKgZoLjLXO41F1L8ncNBmdyAkUR2E,48310
 tdcrpy/TDCRoptimize.py,sha256=qAdSPzrr7HLznFItZNX03LatOONvAWfZRFR22iLH5mI,2831
 tdcrpy/__init__.py,sha256=DrgMGzw5vhdxbXvJq3orzdPeFaq8CwtDHzssp1_DqhM,93
 tdcrpy/config.toml,sha256=Sbu_85L9REvYT9s4uFiqD8yZ8ju6Qyca91RiQOnytA0,1038
@@ -22,8 +22,8 @@ tdcrpy/Quenching/alpha_toulene.txt,sha256=3aIOCC1h19z8E0JZ2_MaSWRWcdnr-mtmT4qEF6
 tdcrpy/decayData/All-nuclides_BetaShape.zip,sha256=ZBeaOUBO09gKGD6ouUXNW5UzdHavTKN5cACTqPqA-KU,6507983
 tdcrpy/decayData/All-nuclides_Ensdf.zip,sha256=LVNNlE_akrg0T-N-7puMuGAme4JRzg-D1YaOwXpiIvg,424716
 tdcrpy/decayData/All-nuclides_PenNuc.zip,sha256=DmhS2CYegWhL8qggc_MO6FgyiXE5qX73dOoH-SSQXoo,388954
-TDCRPy-0.0.46.dist-info/LICENCE.md,sha256=fuYzrZRiOAjJBzA1tsGQwojCgGROArb2Ec48GDTjlWM,1086
-TDCRPy-0.0.46.dist-info/METADATA,sha256=SlIF-OJ4cfeDEJLopiz6SnC0bpFRiCP3ZCR5Y_5dFpM,5633
-TDCRPy-0.0.46.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-TDCRPy-0.0.46.dist-info/top_level.txt,sha256=VgPJa9YJ7fi8wrr9qDJPLhu3tK1BcFRIP6Ib4r3BEfs,7
-TDCRPy-0.0.46.dist-info/RECORD,,
+TDCRPy-0.0.48.dist-info/LICENCE.md,sha256=fuYzrZRiOAjJBzA1tsGQwojCgGROArb2Ec48GDTjlWM,1086
+TDCRPy-0.0.48.dist-info/METADATA,sha256=CQsdzzcNnSUoFw7jP5_Rr-qkGOtn_JMiMyRrPlgo1b0,6214
+TDCRPy-0.0.48.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
+TDCRPy-0.0.48.dist-info/top_level.txt,sha256=VgPJa9YJ7fi8wrr9qDJPLhu3tK1BcFRIP6Ib4r3BEfs,7
+TDCRPy-0.0.48.dist-info/RECORD,,

{TDCRPy-0.0.46.dist-info → TDCRPy-0.0.48.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: bdist_wheel (0.41.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tdcrpy/TDCRPy.py

@@ -36,10 +36,7 @@ def TDCRPy(L, TD, TAB, TBC, TAC, Rad, pmf_1, N, kB, mode, mode2, Display=False,
     pmf_1 : string
         list of probability of each radionuclide (eg. "0.8, 0.2").
     N : integer
-        Number of Monte-Carlo trials. recommanded N=10000
-        N=1000, relative uncertainty from MC calculation = 1.0 %
-        N=10000, relative uncertainty from MC calculation = 0.33 %
-        N=100000, relative uncertainty from MC calculation = 0.10 %
+        Number of Monte-Carlo trials. recommanded N>10000. Not applied in the case of pure beta emitting radionuclides.
     kB : float
         Birks constant in cm/keV.
     mode : string
@@ -137,7 +134,7 @@ def TDCRPy(L, TD, TAB, TBC, TAC, Rad, pmf_1, N, kB, mode, mode2, Display=False,
         efficiency_BC = []
         efficiency_AC = []
         
-        if barp and not Display: NN = tqdm(range(N), desc="Processing", unit=" trial")
+        if barp and not Display: NN = tqdm(range(N), desc="Processing", unit=" decays")
         else: NN = range(N)
         for i in NN: # Main Loop - Monte Carlo trials
             particle_vec=[]

tdcrpy/TDCR_model_lib.py

@@ -10,6 +10,7 @@ Bureau International des Poids et Mesures
 
 ### IMPORT Python Module
 import importlib.resources
+import pkg_resources
 import configparser
 import numpy as np
 import zipfile as zf
@@ -1163,29 +1164,25 @@ def clear_terminal():
 def display_header():
     # Function to display the header
     clear_terminal()
-#     header_text = r'''
-#  ______  ______  ______ _______  ________
-# |__  __||  ___ \|  ___||  ___ | |  ____ |
-#   | |   | |  | || |    | |  | | | |___| |___     ___
-#   | |   | |  | || |    | |__| | |  _____|\  \   |  |
-#   | |   | |__| || |____|  __  \ | |       \  \  |  |
-#   |_|   |_____/ |_____||_|  \__\|_|        \  \_|  |
-#  +++++++++++++++++++++++++++++++++++++++++ /      /
-#  _________________________________________/     /
-# |_____________________________________________/     
-
-#  BIPM 2023 - licence MIT
-#  https://pypi.org/project/TDCRPy/
-#  https://github.com/RomainCoulon/TDCRPy
- 
-#  Start Calculation
-
-# '''
+    version = pkg_resources.get_distribution("tdcrpy").version
     header_text = r'''
- TDCRPy 0.0.X (version alpha)
- BIPM 2023 - licence MIT
- https://pypi.org/project/TDCRPy/
- 
- Start Calculation
+ ______  ______  ______ _______  ________
+|__  __||  ___ \|  ___||  ___ | |  ____ |
+  | |   | |  | || |    | |  | | | |___| |___     ___
+  | |   | |  | || |    | |__| | |  _____|\  \   |  |
+  | |   | |__| || |____|  __  \ | |       \  \  |  |
+  |_|   |_____/ |_____||_|  \__\|_|        \  \_|  |
+  +++++++++++++++++++++++++++++++++++++++++/      /
+  ________________________________________/      /
+ |______________________________________________/     
+
 '''
+    header_text2 = "version "+version+"\n\
+BIPM 2023 - license MIT \n\
+distribution: https://pypi.org/project/TDCRPy \n\
+developement: https://github.com/RomainCoulon/TDCRPy \n\n\
+start calculation..."
+ 
+ # Start Calculation
     print(header_text)
+    print(header_text2)