physplot 0.1.0.post1__tar.gz → 0.1.2__tar.gz

physplot-0.1.2/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: physplot
+Version: 0.1.2
+Summary: Plotting, curve fitting, and error propagation tools for physics labs
+Author: Anant Mathur
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: sympy
+
+# physplot
+
+Plotting and error propagation tools related to lab work for students.
+
+## Usage
+
+Import using: from physplot import Graph, Error, Propagation
+
+1. Graphing:
+    - Create figure and plot axes: Graph.plot_details(#row_plots, #col_plots, width, height, ...)
+    - Create Graph object: graph_obj = Graph(axs[#row, #col], x, y)
+    - Plot and decorate the object: obj.grapher(...) or Graph.grapher(obj, ...)
+    - Show graph: Graph.show()
+2. Error Data:
+    - Create Error object: err_obj = Error(data)
+    - Calculate error (can add certain constraints): err = Error.err(err_obj, ...) or err_obj.err(...)
+3. Error Propagation:
+    - Create Propagation object with 2 methods:
+         - Use Error object: prop_obj = Propagation({variable : err_obj}, ...)
+         - Use external error data: prop_obj = Propagation(manual_data = data, manual_err = err, ...)
+    - Calculate propagated error: Propagation.propagator(prop_obj, expression, ...) or prop_obj.propagator(expression, ...)
+
+## Dependencies
+Requires numpy, matplotlib, scipy and sympy (come with installation of physplot)
+
+## Installation
+```bash
+pip install physplot

physplot-0.1.2/README.md

@@ -0,0 +1,28 @@
+# physplot
+
+Plotting and error propagation tools related to lab work for students.
+
+## Usage
+
+Import using: from physplot import Graph, Error, Propagation
+
+1. Graphing:
+    - Create figure and plot axes: Graph.plot_details(#row_plots, #col_plots, width, height, ...)
+    - Create Graph object: graph_obj = Graph(axs[#row, #col], x, y)
+    - Plot and decorate the object: obj.grapher(...) or Graph.grapher(obj, ...)
+    - Show graph: Graph.show()
+2. Error Data:
+    - Create Error object: err_obj = Error(data)
+    - Calculate error (can add certain constraints): err = Error.err(err_obj, ...) or err_obj.err(...)
+3. Error Propagation:
+    - Create Propagation object with 2 methods:
+         - Use Error object: prop_obj = Propagation({variable : err_obj}, ...)
+         - Use external error data: prop_obj = Propagation(manual_data = data, manual_err = err, ...)
+    - Calculate propagated error: Propagation.propagator(prop_obj, expression, ...) or prop_obj.propagator(expression, ...)
+
+## Dependencies
+Requires numpy, matplotlib, scipy and sympy (come with installation of physplot)
+
+## Installation
+```bash
+pip install physplot

{physplot-0.1.0.post1 → physplot-0.1.2}/physplot/error.py

@@ -1,5 +1,5 @@
 import numpy as np
-from typing import Dict, Sequence, Union
+from typing import Sequence, Union
 
 NumberArray = Union[float, int, np.ndarray, Sequence[float]]
 

{physplot-0.1.0.post1 → physplot-0.1.2}/physplot/graph.py

@@ -15,6 +15,7 @@ class Graph:
         self.x_axis_mean, self.x_err_mean = self._normalize_axis(x_axis, x_err)
         self.y_axis_mean, self.y_err_mean = self._normalize_axis(y_axis, y_err)
         self.parameters = None
+        self.r_value = None
 
     @staticmethod
     def plot_details(rows, cols, x_size, y_size, text=None, fontsize=None):
@@ -33,7 +34,7 @@ class Graph:
                 x_tick_start=None, x_tick_end=None, x_tick_step=None, y_tick_start=None,
                 y_tick_end=None, y_tick_step=None, line_fit_bool=False,
                 curve_fit_bool=False, fit_func=None, p0=None, fit_colors=None, fit_labels=None,
-                minor_ticks=True):
+                minor_ticks=True, r_bool = False):
 
         if self.y_err is not None or self.x_err is not None:
             self._handle_errors()
@@ -43,7 +44,7 @@ class Graph:
         if line_fit_bool:
             self._fit_line()
         if curve_fit_bool:
-            self._fit_curve(fit_func, p0, fit_colors, fit_labels)
+            self._fit_curve(fit_func, p0, fit_colors, fit_labels, r_bool)
         self._set_ticks(x_tick_start, x_tick_end, x_tick_step,
                         y_tick_start, y_tick_end, y_tick_step, minor_ticks)
         self._finalize_plot(title, x_label, y_label, text)
@@ -70,7 +71,7 @@ class Graph:
         fit_line = np.polyval(self.parameters, self.x_axis_mean)
         self.axis.plot(self.x_axis_mean, fit_line, color='grey', linestyle='dashed', label='Linear Fit')
 
-    def _fit_curve(self, fit_func, p0, fit_colors, fit_labels):
+    def _fit_curve(self, fit_func, p0, fit_colors, fit_labels, r_bool):
         if fit_func is None:
             raise ValueError("Provide fit_func for curve fitting.")
         fit_funcs = fit_func if isinstance(fit_func, (list, tuple)) else [fit_func]
@@ -82,10 +83,14 @@ class Graph:
 
         for i, func in enumerate(fit_funcs):
             try:
-                popt, _ = curve_fit(func, self.x_axis_mean, self.y_axis_mean, p0=p0s[i])
+                popt, _ = curve_fit(func, self.x_axis_mean, self.y_axis_mean, p0=p0s[i], absolute_sigma = True)
                 self.parameters.append(popt)
                 fitted_y = func(x_fit, *popt)
                 self.axis.plot(x_fit, fitted_y, color=fit_colors[i], linestyle='dashed', label=fit_labels[i])
+
+                if r_bool:
+                    self.r_value = np.corrcoef(self.x_axis_mean, self.y_axis_mean)[0, 1]
+
             except Exception as e:
                 print(f"Curve Fit {fit_labels[i]} failed: {e}")
                 self.parameters.append(None)
@@ -159,4 +164,16 @@ class Graph:
             return err_array
         else:
             collapsed = np.nanmean(err_array, axis=tuple(range(1, err_array.ndim)))
-            return collapsed
+            return collapsed
+
+    @staticmethod
+    def show():
+        plt.show()
+
+    @staticmethod
+    def savefig(filepath, dpi):
+        plt.savefig(filepath, dpi = dpi)
+
+    def label(self, text: str, x, y, v_al = None, h_al = None):
+        self.axis.text(x, y, f"{text}", transform = self.axis.transAxes, fontsize = 12,
+                        verticalalignment = v_al, horizontalalignment = h_al)

physplot-0.1.2/physplot.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: physplot
+Version: 0.1.2
+Summary: Plotting, curve fitting, and error propagation tools for physics labs
+Author: Anant Mathur
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: sympy
+
+# physplot
+
+Plotting and error propagation tools related to lab work for students.
+
+## Usage
+
+Import using: from physplot import Graph, Error, Propagation
+
+1. Graphing:
+    - Create figure and plot axes: Graph.plot_details(#row_plots, #col_plots, width, height, ...)
+    - Create Graph object: graph_obj = Graph(axs[#row, #col], x, y)
+    - Plot and decorate the object: obj.grapher(...) or Graph.grapher(obj, ...)
+    - Show graph: Graph.show()
+2. Error Data:
+    - Create Error object: err_obj = Error(data)
+    - Calculate error (can add certain constraints): err = Error.err(err_obj, ...) or err_obj.err(...)
+3. Error Propagation:
+    - Create Propagation object with 2 methods:
+         - Use Error object: prop_obj = Propagation({variable : err_obj}, ...)
+         - Use external error data: prop_obj = Propagation(manual_data = data, manual_err = err, ...)
+    - Calculate propagated error: Propagation.propagator(prop_obj, expression, ...) or prop_obj.propagator(expression, ...)
+
+## Dependencies
+Requires numpy, matplotlib, scipy and sympy (come with installation of physplot)
+
+## Installation
+```bash
+pip install physplot

{physplot-0.1.0.post1 → physplot-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "physplot"
-version = "0.1.0.post1"
+version = "0.1.2"
 description = "Plotting, curve fitting, and error propagation tools for physics labs"
 authors = [{name = "Anant Mathur"}]
 readme = { file = "README.md", content-type = "text/markdown" }

physplot-0.1.0.post1/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.4
-Name: physplot
-Version: 0.1.0.post1
-Summary: Plotting, curve fitting, and error propagation tools for physics labs
-Author: Anant Mathur
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: matplotlib
-Requires-Dist: scipy
-Requires-Dist: sympy
-
-# physplot
-
-Plotting and error propagation tools for physics labs.
-
-## Installation
-```bash
-pip install physplot

physplot-0.1.0.post1/README.md

@@ -1,7 +0,0 @@
-# physplot
-
-Plotting and error propagation tools for physics labs.
-
-## Installation
-```bash
-pip install physplot

physplot-0.1.0.post1/physplot.egg-info/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.4
-Name: physplot
-Version: 0.1.0.post1
-Summary: Plotting, curve fitting, and error propagation tools for physics labs
-Author: Anant Mathur
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: matplotlib
-Requires-Dist: scipy
-Requires-Dist: sympy
-
-# physplot
-
-Plotting and error propagation tools for physics labs.
-
-## Installation
-```bash
-pip install physplot