ieeLabTools 0.1.2__tar.gz → 0.1.3__tar.gz

ieelabtools-0.1.3/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

{ieelabtools-0.1.2 → ieelabtools-0.1.3/Docs}/Documentation.md

@@ -1,5 +1,7 @@
 # Documentation
 
+<a href="https://github.com/ieepirzy/PhySiLight-Tools/blob/main/Packages/ieeLabTools/suomidocs.md"> Dokumentaation pikaohjeet suomeksi </a>
+
 ## Quickstart / TL;DR
 
 ```python
@@ -10,7 +12,7 @@ import numpy as np
 #Example variables and function
 U, I = sp.symbols("U I")
 R = U/I
-calc = Yvel(R)
+calc = Yvel(R,vars=[U,I])
 
 U_vals = np.array([1,2,3,4,5,6])
 I_vals = np.array([6,5,4,3,2,1])
@@ -23,6 +25,10 @@ sigmas = np.column_stack([U_err, I_err])
 sigma_R = calc.numeric(values, sigmas)
 ``` 
 
+>⚠ Important ⚠:
+>The order of columns in `values` and `sigmas` must match the order of variables in `vars`.
+>If `vars` is omitted, variables are ordered lexicographically by symbol name.
+
 > ⚠ The current version uses the **non-covariant** general error propagation formula. Covariance-aware propagation is planned for a future release.
 
 ## 1. YVEL: Yleinen virheen etenemisen lauseke
@@ -40,6 +46,7 @@ The **initializer expects a sympy object representing the function** referred to
 An optional parameter for the initializer is a 1D array-like of the **variables as Sympy symbols** referred to as `var`.
 
 For note, the covariant expression for the YVEL is:
+
 $$
 \sigma = \sqrt{ \sum_{i}  \left( \frac{\partial f}{\partial x_{i}} \right) ^{2}\sigma_{i}^{2} +2 \sum_{i>j} \frac{\partial f}{\partial x_{i}} \frac{\partial f}{\partial x_{j}} \text{cov}(x_{i},x_{j}) }
 $$
@@ -55,9 +62,11 @@ Then a symbolic representation of the general error propagation equation is buil
 #### Example.
 
 For a simplistic example, consider Ohm's law:
+
 $$
 R=\frac{U}{I}
 $$
+
 To find the deviation for $R$ using the ieeLabTools package, we will first build an instance of the Yvel class:
 >Note: for correct usage, some degree of familiarity with numpy and sympy is required.
 
@@ -136,7 +145,7 @@ $$
 
 Internally, the method uses numpy for vectorized processing and does shape validation. 
 
-Example usage:
+Example usage for `numeric()` continuing with the same instance of the class as in the quickstart:
 ```python
 #lets assume the variables from earlier have some values and deviations:
 import numpy as np
@@ -169,4 +178,23 @@ print(deviation)
 
 ```
 
+Note: The known bug causing indeterministic ordering in Sympy's `free_symbols` method means that it is usually preferred to pass the variables explicitly, as how the script enforces deterministic ordering is by sorting the variables found by free_symbols lexographically, and as the user passes data to the `numeric()` method, must the ordering of the arrays corresponding to each measurement be in lexicographical order (the same order as the variables).
+
+> Note: The bug arrises from the way the set() function, used in the `free_symbols` method interacts with pythons HASHSEED.
+> HASHSEED being randomized for DoS-attack prevention. It is then assumed that if order matters, it is specified, hence a strong recommendation to pass the `vars` as a parameter directly.
+
+Example of indeterministic behaviour:
+
+```python
+
+# DON'T DO THIS - order may vary between runs:
+calc = Yvel(R)  # vars detected as [I, U] or [U, I] unpredictably
+values = np.column_stack([U_vals, I_vals])  # assumes [U, I]
+# ❌ Mismatch possible!
+
+# DO THIS - explicit and deterministic:
+calc = Yvel(R, vars=[U, I])  # ✅ Order guaranteed
+values = np.column_stack([U_vals, I_vals])
+
+```
 

ieelabtools-0.1.3/Docs/suomidocs.md

@@ -0,0 +1,42 @@
+# Dokumentaatio
+
+Saat moduulin käyttöösi suorittamalla komennon:
+
+```CLI
+pip install ieeLabTools
+```
+
+<a href="https://pypi.org/project/ieeLabTools/">Moduuli on julkaistu PyPi alustalle</a>
+
+## Pikaesimerkki:
+```python
+from ieeLabTools.core import Yvel
+import sympy as sp
+import numpy as np
+
+#Luodaan esimerkkimuuttujat, näiden täytyy olla sympy-symboleja
+U, I = sp.symbols("U I")
+R = U/I #Rakennetaan symboleista/muututjista esimerkkifunktio
+calc = Yvel(R) # Tässä luodaan Yvel-objekti yllä määritetyllä funktiolla. 
+#TS. Jotta voit käyttää Yvel:iä niin anna sille aina aluksi näin funktio
+
+#Esimerkki arvot ja virheet.
+U_arvot = np.array([1,2,3,4,5,6]) 
+I_arvot = np.array([6,5,4,3,2,1])
+U_err = U_arvot*0.001
+I_err = I_arvot*0.05
+
+#Muutetaan np.column_stack() metodilla arvot ja virheet muotoon, jota numeerinen laskuri odottaa.
+arvot = np.column_stack([U_arvot, I_arvot]) 
+virheet = np.column_stack([U_err, I_err])
+
+# numeric() metodi odottaa parametreikseen m x k matriisin, jossa m on mittaussarjan pituus ja k muuttujien määrä.
+sigma = calc.numeric(arvot, virheet) #Tällä tavalla kutsutaan numeric() metodia.
+``` 
+
+>Huom! Kaikilla muuttujilla ja virheillä tulee olla sama muoto. Eli mittaussarjoilla sama pituus.
+
+>Huom! Jos jollakin muuttujalla ei ole virhettä, niin käytä sen virhesarjana 0-sarjaa.
+
+Metodi toimii vain **toisistaan riippumattomille** muuttujille.
+Kattavampi dokumentaatio ja läpikäyminen löytyy englanninkielisestä veriosta.

ieelabtools-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ilari Pirkkalainen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{ieelabtools-0.1.2 → ieelabtools-0.1.3}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: ieeLabTools
-Version: 0.1.2
-Summary: General symbolic + numeric uncertainty propagation, weighted linear regression
-Project-URL: Homepage, https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools
-Project-URL: Documentation, https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools/Documentation.md
-Project-URL: Source, https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools/ieeLabTools/core.py
+Version: 0.1.3
+Summary: General linear symbolic + numeric uncertainty propagation, weighted linear regression
+Project-URL: Homepage, https://github.com/ieepirzy/ieeLabTools
+Project-URL: Documentation, https://github.com/ieepirzy/ieeLabTools/blob/main/Docs/Documentation.md
+Project-URL: Source, https://github.com/ieepirzy/ieeLabTools/blob/main/Source/core.py
 Author-email: Ilari Pirkkalainen <iladevv0@gmail.com>
 License: MIT
+License-File: LICENSE
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License

ieelabtools-0.1.3/ieeLabTools/__init__.py

@@ -0,0 +1,20 @@
+"""
+ieeLabTools
+===========
+
+Tools for symbolic and numeric uncertainty propagation
+and weighted linear regression for laboratory data analysis.
+"""
+
+
+from .core import (
+    Yvel,
+    WeightedLinregress,
+)
+
+__all__ = [
+    "Yvel",
+    "WeightedLinearRegression",
+]
+
+__version__ = "0.1.2"

{ieelabtools-0.1.2 → ieelabtools-0.1.3}/ieeLabTools/core.py

@@ -20,26 +20,34 @@ class Yvel():
         
         self.f = f
         
+        # Assign from user declared variables or find variables automatically
         if vars is not None:
             self.vars = vars
         else: 
-            self.vars = list(f.free_symbols)
-        
+            self.vars = sorted(f.free_symbols, key=lambda s: s.name)
+
+        #print(f"variables:{self.vars}") #debug print 
+
+        # Find partials with sp.diff, looping over the function with each variable 
         self.partials = []
         for v in self.vars:
             self.partials.append(sp.diff(self.f,v))
         
-        
+        #Creating sigmas for all variables
         self.sigmas = []
         for v in self.vars:
-            sigma = sp.Symbol(f"sigma_{v.name}")
+            sigma = sp.Symbol(f"σ{v.name}")
             self.sigmas.append(sigma)
-            
+        
+        # Construct symbolical sympy object
         self.symbolic_f = sp.sqrt(
             sum((partial*var)**2 for partial, var in zip(self.partials,self.sigmas))
             )
-                    
+
+        # Lambdify object to make it          
         self.fn = sp.lambdify([*self.vars, *self.sigmas], self.symbolic_f, "numpy")
+
+        # Number of variables for later
         self.k = len(self.vars)
         
     def symbolic(self):
@@ -57,27 +65,34 @@ class Yvel():
         
         Returns: numpy array length m
         """
+
+        # Assign into numpy arrays from input format
         values = np.array(values, dtype=float)
         sigmas = np.array(sigmas, dtype=float)
         
+        # Check correct shape
         if values.shape != sigmas.shape:
             raise ValueError("Measurement and uncertainty matrices must have same shape.")
         m, k = values.shape
         if k != self.k:
             raise ValueError(f"Expected {self.k} variables, got {k} columns.")
         
+        # transpose for correct internal representation
         vt = values.T
         st = sigmas.T
 
-        # build argument list
+        # build argument list, pairing value with deviation.
         args = [vt[i] for i in range(k)] + [st[i] for i in range(k)]
-
+        #print(f"arguments:{args}") #debug print
+        # pass args to lambidified sympy object, representing the function
         return self.fn(*args)
 
     def covariant_numeric(self,values,sigmas):
         return NotImplementedError
 
-class weightedLinregress():
+
+class WeightedLinregress():
+# Rework this to be stateless..
     def __init__(self, y_sigma,x,y):
         """
         Parameters
@@ -130,7 +145,7 @@ class weightedLinregress():
 
         return slope, intercept, slope_err, intercept_err
 
-class ortDistanceRegress():
+class OrtDistanceRegress():
     def __init__(self,x,y,x_sigma,y_sigma):
         
         """

ieelabtools-0.1.3/mytest.py

@@ -0,0 +1,22 @@
+from Source import Yvel
+import sympy as sp
+import numpy as np
+
+#Example variables and function
+U, I = sp.symbols("U I")
+R = U/I
+print(R.free_symbols)
+calc = Yvel(R)
+print(calc)
+print(calc.symbolic())
+U_vals = np.array([1,2,3,4,5,6])
+I_vals = np.array([6,5,4,3,2,1])
+U_err = U_vals*0.001
+I_err = I_vals*0.05
+#Convert to desirable input format: m x k array-like, where k is your number of variables and m is your number of measurement events.
+values = np.column_stack([U_vals, I_vals]) 
+sigmas = np.column_stack([U_err, I_err])
+
+sigma_R = calc.numeric(values, sigmas)
+
+print(sigma_R)

{ieelabtools-0.1.2 → ieelabtools-0.1.3}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "ieeLabTools"
-version = "0.1.2"
-description = "General symbolic + numeric uncertainty propagation, weighted linear regression"
+version = "0.1.3"
+description = "General linear symbolic + numeric uncertainty propagation, weighted linear regression"
 authors = [
   { name = "Ilari Pirkkalainen", email = "iladevv0@gmail.com" }
 ]
@@ -21,9 +21,9 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools"
-Documentation = "https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools/Documentation.md"
-Source = "https://github.com/ieepirzy/PhySiLight-Tools/tree/main/Packages/ieeLabTools/ieeLabTools/core.py"
+Homepage = "https://github.com/ieepirzy/ieeLabTools"
+Documentation = "https://github.com/ieepirzy/ieeLabTools/blob/main/Docs/Documentation.md"
+Source = "https://github.com/ieepirzy/ieeLabTools/blob/main/Source/core.py"
 
 [build-system]
 requires = ["hatchling"]

ieelabtools-0.1.2/ieeLabTools/__init__.py

@@ -1,3 +0,0 @@
-from .core import Yvel, weightedLinregress, ortDistanceRegress
-
-__all__ = ["Yvel", "weightedLinregress","ortDistanceRegress"]