metrolopy 0.6.5__py3-none-any.whl → 1.0.0__py3-none-any.whl

metrolopy/indexed.py

@@ -2,7 +2,7 @@
 
 # module indexed
 
-# Copyright (C) 2019 National Research Council Canada
+# Copyright (C) 2025 National Research Council Canada
 # Author:  Harold Parks
 
 # This file is part of MetroloPy.
@@ -21,10 +21,11 @@
 # MetroloPy. If not, see <http://www.gnu.org/licenses/>.
 
 """
-indexed
+A base class for the Unit and GummyConstant classes.
 """
 
 from importlib import import_module
+from html import escape
 
 
 class _Builtin:
@@ -51,6 +52,8 @@ class Indexed:
     # _lib = {}
     # _open_lib = _builtin_lib
     
+    _case_sensitive = True
+    
     @classmethod
     def alias(cls,alias,inst):
         """
@@ -65,6 +68,10 @@ class Indexed:
             A string referencing the `Indexed` instance that will be assigned
             the alias or the `Indexed` instance its self.
         """
+        if isinstance(alias,str):
+            if not cls._case_sensitive and ' ' in alias:
+                alias = alias.lower()
+            alias = alias.strip()
         inst = cls.get(inst)
         cls._open_lib[alias] = inst
         inst._add_alias(alias)
@@ -77,6 +84,10 @@ class Indexed:
     def get(cls,name,exception=True):
         if isinstance(name,cls):
             return name
+        if isinstance(name,str):
+            if not cls._case_sensitive and ' ' in name:
+                name = name.lower()
+            name = name.strip()
         c = cls._lib.get(name)
         if c is None:
             c = cls._builtin_lib.get(name)
@@ -116,7 +127,13 @@ class Indexed:
     
     def __init__(self,name,symbol=None,short_name=None,add_symbol=False,
                  html_symbol=None,latex_symbol=None,ascii_symbol=None,
-                 description=None):
+                 description=None,case_sensitive=True):
+        
+        tolower = False
+        if isinstance(name,str):
+            if not self._case_sensitive and ' ' in name:
+                tolower = True
+            name = name.strip()
         self.name = name
         self.description=description
         
@@ -126,21 +143,42 @@ class Indexed:
             self.symbol = symbol
             
         if html_symbol is None:
-            self.html_symbol = symbol
+            self.html_symbol = escape(symbol)
         else:
-            self.html_symbol=html_symbol
+            self.html_symbol = html_symbol
         if latex_symbol is None:
-            self.latex_symbol = self.format_latex(symbol)
+            sb = symbol.strip()
+            sc = {
+                '&': r'\&',
+                '%': r'\%',
+                '$': r'\$',
+                '#': r'\#',
+                '_': r'\_',
+                '{': r'\{',
+                '}': r'\}',
+                '~': r'\textasciitilde{}',
+                '^': r'\wedge{}',
+                '\\': r'\textbackslash{}',
+                '<': r'\textless{}',
+                '>': r'\textgreater{}',
+                ' ': r' \ '
+                }
+            self.latex_symbol = self.format_latex(''.join(sc[c] if c in sc 
+                                                          else c 
+                                                          for c in sb))
         else:
             self.latex_symbol = self.format_latex(latex_symbol)
         if ascii_symbol is None:
-            self.ascii_symbol=symbol
+            self.ascii_symbol = ''.join(i if ord(i) < 128 else '_' for i in symbol)
         else:
             self.ascii_symbol=ascii_symbol
             
         self._aliases = set()
         
-        self._open_lib[name] = self
+        if tolower:
+            self._open_lib[name.lower()] = self
+        else:
+            self._open_lib[name] = self
         if add_symbol:
             if symbol.strip() != name:
                 self._open_lib[symbol.strip()] = self
@@ -150,8 +188,15 @@ class Indexed:
                 self._open_lib[ascii_symbol.strip()] = self
                 self._aliases.add(ascii_symbol.strip())
         if short_name is not None:
-            self._open_lib[short_name] = self
+            tolower = False
+            if isinstance(short_name,str):
+                if not self._case_sensitive and ' ' in short_name:
+                    tolower = True
+                short_name = short_name.strip()
             self.short_name = short_name
+            if tolower:
+                short_name = short_name.lower()
+            self._open_lib[short_name] = self
             self._aliases.add(short_name)
         else:
             if add_symbol:
@@ -185,22 +230,26 @@ class Indexed:
     def _add_alias(self,alias):
         self._aliases.add(alias)
         
-    def tostring(self,fmt=None,**kwds):
+    def tostring(self,fmt=None,strip=True,**kwds):
         """
         Returns a string containing the symbol for the instance in the format
         given by the keyword `fmt` which may be set to a string the values 
         'html', 'latex', 'ascii' or 'unicode'.  
         """
         if fmt is None or fmt == 'unicode':
-            return self.symbol
-        if fmt is None:
-            return self.symbol
-        if fmt == 'html':
-            return self.html_symbol
-        if fmt == 'latex':
-            return self.latex_symbol
-        if fmt == 'ascii':
-            return self.ascii_symbol
-        raise ValueError('format ' + str(fmt) + ' is not recognized')
+            ret = self.symbol
+        elif fmt is None:
+            ret = self.symbol
+        elif fmt == 'html':
+            ret = self.html_symbol
+        elif fmt == 'latex':
+            ret = self.latex_symbol
+        elif fmt == 'ascii':
+            ret =  self.ascii_symbol
+        else:
+            raise ValueError('format ' + str(fmt) + ' is not recognized')
+        if strip:
+            ret = ret.strip()
+        return ret
 
     

metrolopy/logunit.py

@@ -2,7 +2,7 @@
 
 # module logunit
 
-# Copyright (C) 2019 National Research Council Canada
+# Copyright (C) 2025 National Research Council Canada
 # Author:  Harold Parks
 
 # This file is part of MetroloPy.

metrolopy/mean.py

@@ -2,7 +2,7 @@
 
 # module mean
 
-# Copyright (C) 2019 National Research Council Canada
+# Copyright (C) 2025 National Research Council Canada
 # Author:  Harold Parks
 
 # This file is part of MetroloPy.
@@ -26,7 +26,6 @@ Some miscellaneous functions that are useful for uncertainty analysis.
 
 import numpy as np
 from .gummy import gummy
-from .distributions import TDist
 import datetime
 
 def autocorrelation(x):
@@ -182,7 +181,7 @@ def wmean(x,chi_correct=False):
         
     return ret
     
-def mean(x,n_sigma_trim=3,unit=1,ignore_nan=True,use_n_eff=None):
+def mean(x,n_sigma_trim=3,unit=1,ignore_nan=True,use_n_eff=None,utype=None):
     """
     Returns a gummy representing the mean of a float array.
     
@@ -232,11 +231,11 @@ def mean(x,n_sigma_trim=3,unit=1,ignore_nan=True,use_n_eff=None):
     if dof < 1:
         dof = 1
         
-    u = float(np.std(x,ddof=1))/np.sqrt(n)
+    u = float(np.std(x,ddof=1)/np.sqrt(n))
     if gummy.bayesian:
         u *= np.sqrt(dof/(dof-2))
 
-    return gummy(m,u,dof=dof,unit=unit)
+    return gummy(m,u,dof=dof,unit=unit,utype=utype)
     
 def sigma_trim(x, n_sigma = 3):
     """
@@ -284,7 +283,7 @@ def delta_diff(x):
     z[0::2] = -z[0::2]
     return z
 
-def delta_diff_mean(x,n_sigma=None,unit=1):
+def delta_diff_mean(x,n_sigma=None,unit=1,utype=None):
     """
     Returns a gummy representing the mean value and uncertainty of a delta 
     type difference taken on the data.  A delta type difference removes a 
@@ -334,7 +333,7 @@ def delta_diff_mean(x,n_sigma=None,unit=1):
     if gummy.bayesian:
         u *= np.sqrt(dof/(dof-2))
     
-    return gummy(mn,u,dof=dof,unit=unit)
+    return gummy(float(mn),u=float(u),dof=dof,unit=unit,utype=utype)
     
 def delta_sum(x):
     """Returns a list containing differences of the type:
@@ -354,7 +353,7 @@ def delta_sum(x):
     z[0::2] = -z[0::2]
     return delta_diff(z)/2.0
     
-def delta_sum_mean(x,n_sigma=None,unit=1):
+def delta_sum_mean(x,n_sigma=None,unit=1,utype=None):
     """
     Returns a gummy representing the mean value
     and uncertainty of a delta type difference taken on the data.  A delta type 
@@ -383,7 +382,7 @@ def delta_sum_mean(x,n_sigma=None,unit=1):
     """
     z = np.asanyarray(x)
     z[0::2] = -z[0::2]
-    return delta_diff_mean(z,n_sigma,unit)/2.0
+    return delta_diff_mean(z,n_sigma,unit=unit,utype=utype)/2.0
     
 def mean_datetime(*params):
     if len(params) == 1:

metrolopy/miscunits.py

@@ -2,7 +2,7 @@
 
 # module miscunits
 
-# Copyright (C) 2019 National Research Council Canada
+# Copyright (C) 2025 National Research Council Canada
 # Author:  Harold Parks
 
 # This file is part of MetroloPy.
@@ -29,10 +29,9 @@ non-SI units accepted for use with the SI not in the siunits module, some
 obsolete SI units, and a few other units.
 """
 
-from numpy import sqrt,log,log2
-from .gummy import gummy,_lg10
-from .ummy import MFraction
-from .unit import Unit,Conversion
+from numpy import sqrt,log,log2,log10
+from .gummy import gummy
+from .unit import Unit,Conversion,MFraction
 from .prefixedunit import PrefixedUnit,BinaryPrefixedUnit
 from .logunit import LogUnit,LogConversion
 from .siunits import (_kg,_V,_ohm,_s,_K,_J,_m,_d,_min,_h,_W,_Hz,_C,_A,_N,_cm,
@@ -40,6 +39,22 @@ from .siunits import (_kg,_V,_ohm,_s,_K,_J,_m,_d,_min,_h,_W,_Hz,_C,_A,_N,_cm,
 from .constcom import (dalton,KJ,RK,KJ90,RK90,e,c,solar_mass,jupiter_mass,
                        earth_mass,hbar,a0,me,mp,G,alph,k,pi,euler)
 
+def _lg10(x):
+    try:
+        from mpmath import mpf
+        from mpmath import log10 as mlog10
+    except:
+        mlog10 = mpf = None
+        
+    if isinstance(x,mpf):
+        return mlog10(x)
+    if hasattr(x,'log10'):
+        return x.log10()
+    try:
+        return log10(x)
+    except:
+        return log10(float(x))
+
 with Unit._builtin():
     
     # non-SI accepted for use with the SI, SI Brochure, 9th ed
@@ -146,7 +161,7 @@ with Unit._builtin():
                add_symbol=True,html_symbol='<i>E</i><sub>h</sub>',latex_symbol='\t\tE_{\\mathrm{h}}',
                description='natural, atomic unit of energy')
     Unit.alias('Ha',_Eh)
-    Unit('reduced compton wavelength','\u019b(C)',
+    Unit('reduced Compton wavelength','\u019b(C)',
          Conversion(_hbar*_me**-1*_c**-1,1),order=0,add_symbol=True,
          html_symbol='\u019b<sub>C</sub>',latex_symbol='\t\t\u019b_{\\mathrm{C}}',
          ascii_symbol='lambda(C)',