struct_post 0.1.5__tar.gz → 0.1.8__tar.gz

{struct_post-0.1.5 → struct_post-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: struct_post
-Version: 0.1.5
+Version: 0.1.8
 Summary: A module designed to analyse common structural test results.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -8,6 +8,13 @@ License-File: LICENSE
 Requires-Dist: matplotlib>=3.10.6
 Requires-Dist: openpyxl>=3.1.5
 Requires-Dist: pandas>=2.3.2
+Requires-Dist: requests>=2.32.5
+Provides-Extra: doc
+Requires-Dist: sphinx>=8.0; extra == "doc"
+Requires-Dist: myst-parser>=4.0.1; extra == "doc"
+Requires-Dist: nbsphinx>=0.9.7; extra == "doc"
+Requires-Dist: pydata-sphinx-theme>=0.16.1; extra == "doc"
+Requires-Dist: ipykernel>=6.30.1; extra == "doc"
 Dynamic: license-file
 
 # struct_post

{struct_post-0.1.5 → struct_post-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "struct_post"
-version = "0.1.5"
+version = "0.1.8"
 description = "A module designed to analyse common structural test results."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -8,4 +8,14 @@ dependencies = [
     "matplotlib>=3.10.6",
     "openpyxl>=3.1.5",
     "pandas>=2.3.2",
+    "requests>=2.32.5",
+]
+
+[project.optional-dependencies]
+doc = [
+    "sphinx>=8.0",
+    "myst-parser>=4.0.1",
+    "nbsphinx>=0.9.7",
+    "pydata-sphinx-theme>=0.16.1",
+    "ipykernel>=6.30.1"
 ]

struct_post-0.1.8/struct_post/beam.py

@@ -0,0 +1,163 @@
+from pandas import DataFrame
+import pandas as pd
+
+def beam_lvmdata_file(file_name, force_index=2, displ_index=3,
+             mid_lvdt_ind=None, left_lvdt_ind=None, right_lvdt_ind=None):
+    """
+    Read a .lvm file and extract force, displacement, and LVDT data in groups.
+
+    Parameters
+    ----------
+    file_name : str
+        Path to the .lvm file to read.
+    force_index : int, default=2
+        1-based column index for the force data.
+    displ_index : int, default=3
+        1-based column index for the displacement (stroke) data.
+    mid_lvdt_ind : int or list of int, optional
+        Column index/indices for the middle LVDTs.
+    left_lvdt_ind : int or list of int, optional
+        Column index/indices for the left LVDTs.
+    right_lvdt_ind : int or list of int, optional
+        Column index/indices for the right LVDTs.
+
+    Returns
+    -------
+    df_new : pandas.DataFrame
+        Extracted data as a DataFrame with columns renamed:
+        ['Force (kN)', 'Stroke (mm)', 'Mid_1 (mm)', 'Mid_2 (mm)',
+         'Left_1 (mm)', 'Left_2 (mm)', 'Right_1 (mm)', 'Right_2 (mm)'].
+        Only existing columns are included; missing columns are ignored.
+    file_base_name : str
+        Base name of the file without the '.lvm' extension.
+
+    Notes
+    -----
+    - Automatically detects the start of the data by locating the last
+      occurrence of '***End_of_Header***' in the file.
+    - Converts all columns to numeric values; non-numeric entries
+      are coerced to NaN.
+    - The last column is dropped assuming it is empty.
+    - Single integer indices are automatically converted to lists.
+    - LVDT columns are combined in the order: mid -> left -> right.
+    """
+    
+    mid_lvdt_ind = mid_lvdt_ind or []
+    left_lvdt_ind = left_lvdt_ind or []
+    right_lvdt_ind = right_lvdt_ind or []
+    
+    if isinstance(mid_lvdt_ind, int):
+        mid_lvdt_ind = [mid_lvdt_ind]
+    if isinstance(left_lvdt_ind, int):
+        left_lvdt_ind = [left_lvdt_ind]
+    if isinstance(right_lvdt_ind, int):
+        right_lvdt_ind = [right_lvdt_ind]
+    
+    lvdt_indices = mid_lvdt_ind + left_lvdt_ind + right_lvdt_ind
+    
+    with open(file_name, 'r') as f:
+        lines = f.readlines()
+    start_idx = max(i for i, line in enumerate(lines) if "***End_of_Header***" in line) + 1
+    df = pd.read_csv(file_name, sep="\t", skiprows=start_idx)
+    df = df.apply(pd.to_numeric, errors='coerce')
+    df = df.drop(df.columns[-1], axis=1)
+    
+    user_indices = [force_index, displ_index] + lvdt_indices
+    existing_cols = [df.columns[i-1] for i in user_indices if i-1 < len(df.columns)]
+    
+    df_new = df[existing_cols].copy()
+    
+    col_names = ['Force (kN)','Stroke (mm)','Mid_1 (mm)','Mid_2 (mm)','Left_1 (mm)','Left_2 (mm)','Right_1 (mm)','Right_2 (mm)']
+    df_new.columns = col_names[:len(existing_cols)]
+    
+    return df_new, file_name[:-4]
+
+def beam_four_point_bending (data: DataFrame, 
+                        width: float, 
+                        depth: float, 
+                        beam_span: float):
+    """
+    Perform four-point bending analysis to calculate apparent and true modulus of elasticity.
+
+    Parameters
+    ----------
+    data : tuple
+        A tuple containing:
+        - data[0] : pandas.DataFrame
+            Experimental dataset with columns:
+            - 'Moog Force_kN' : Applied load (kN).
+            - 'LVDT 1_mm' ... 'LVDT 6_mm' : Deflections from six LVDTs (mm).
+        - data[1] : str
+            Sample name identifier.
+    width : float
+        Beam specimen width (mm).
+    depth : float
+        Beam specimen depth (mm).
+    beam_span : float
+        Beam span length (mm).
+
+    Returns
+    -------
+    tuple
+        (sample_name, results) where:
+        - sample_name : str
+            Name of the processed sample.
+        - results : dict
+            Dictionary containing:
+            - "E_app" : float
+                Apparent modulus of elasticity (MPa).
+            - "E_true" : float
+                True modulus of elasticity (MPa).
+
+    Notes
+    -----
+    - Apparent modulus (E_app) is calculated from mid-span deflection (LVDT 3 & 4).
+    - True modulus (E_true) is calculated from relative deflection (mid-span vs. supports).
+    - Load range for regression is limited to 10–40% of ultimate load.
+    """
+    
+    import pandas as pd
+    import numpy as np
+
+    #Experimental test data post-process
+    sample_name = data[1]
+    force = data[0]['Force (kN)'] * 1000
+    delta_1 = abs(data[0]['Left_1 (mm)'])
+    delta_2 = abs(data[0]['Left_2 (mm)'])
+    delta_3 = abs(data[0]['Mid_1 (mm)'])
+    delta_4 = abs(data[0]['Mid_2 (mm)'])
+    delta_5 = abs(data[0]['Right_1 (mm)'])
+    delta_6 = abs(data[0]['Right_2 (mm)'])
+
+    F_ult = force.max()
+    f_b = (F_ult * beam_span) / (width * depth **2) #MPa
+
+    
+    delta_ms = (delta_3 + delta_4)/2
+    delta_rel = delta_ms - (delta_1 + delta_2 + delta_5 + delta_6) / 4
+    
+    
+    lower_bound = 0.1 * F_ult
+    upper_bound = 0.4 * F_ult
+
+    calcs_reg = (lower_bound <= force) & (force <= upper_bound)
+    
+    F_ms = force[calcs_reg]
+    delta_ms_calcs = delta_ms[calcs_reg]
+    delta_rel_calcs = delta_rel[calcs_reg]
+    
+    Delta_ms, intercept_ms = np.polyfit(delta_ms_calcs,F_ms,1)
+    Delta_rel, intercept_rel = np.polyfit(delta_rel_calcs,F_ms,1)
+    
+    E_app = (23/108) * (beam_span/depth)**3 * Delta_ms * (1/width)
+    E_true = (1/36) *  (beam_span/depth)**3 * Delta_rel * (1/width)
+    
+    results = {
+        "E_app": E_app,
+        "E_true": E_true,
+    }
+
+    print(f"Sample Name: {sample_name}")
+    print('-' * 40)
+    return sample_name, results
+

{struct_post-0.1.5 → struct_post-0.1.8}/struct_post/coupon.py

@@ -69,7 +69,7 @@ def coupon_test_analysis (sample_name: str,
     
     # Calculate stress and strain
     force = Force * 1000 # Convert kN to N
-    stress = (force / area)  # N/m^2 or Pa
+    stress = (force / area)  # N/mm^2 or MPa
     uts = stress.max()
     
     #find the data before uts
@@ -77,7 +77,7 @@ def coupon_test_analysis (sample_name: str,
     strain_up = Strain[:idx_peak+1]
     stress_up = stress[:idx_peak+1]
     
-    #Boundary for 20% - 50% of UTS
+    #Boundary for [low bound] - [up bound] of uts
     lower_bound = low_bound * uts
     upper_bound = up_bound * uts
     
@@ -91,7 +91,7 @@ def coupon_test_analysis (sample_name: str,
     E_GPa = E / 1000  # Convert MPa to GPa
     #print(f"Intercept: {intercept} MPa")
    
-    # Select over 30% of UTS, as yield stress will over 30% uts
+    # Select over [lower bound] of UTS, as yield stress will over [lower bound] uts
     strain_new = strain
     stress_new = force / area
     mask = (lower_bound <= stress)
@@ -143,7 +143,6 @@ def coupon_test_analysis (sample_name: str,
     print(f"Young's Modulus (E): {E:.2f} MPa")
     print(f"Ultimate Tensile Strength (UTS): {uts:.2f} MPa")
     print(f"Yield Strength: {yield_strength:.2f} MPa")
-    print(yield_strain)
     print('-' * 40)
     
     # Prepare results dictionary
@@ -192,25 +191,39 @@ def coupon_batch_analysis(Coupon_geodata: str,
                           showfig: bool = True,
                           savefig: bool = False):
     """
-    Perform batch analysis on a list of samples and return the results.
+    Perform batch analysis on a list of tensile coupon samples and return their results.
 
     Parameters
     ----------
-    Coupon_geodata : list
+    Coupon_geodata : list of SampleDetails
         A list of SampleDetails objects, each containing:
-        - sample_file_name : Name of the sample file
-        - thickness        : Sample thickness
-        - width            : Sample width
+        - sample_file_name : str
+            Path to the sample CSV file.
+        - thickness : float
+            Sample thickness (mm).
+        - width : float
+            Sample width (mm).
+    force_index : int
+        Column index of the Force data in the CSV file (1-based).
+    strain_index : int
+        Column index of the Strain data in the CSV file (1-based).
+    showfig : bool, optional
+        Whether to display stress-strain plots during analysis. Default is True.
     savefig : bool, optional
-        Whether to save the figures generated during analysis. Default is False.
+        Whether to save the stress-strain plots to files. Default is False.
 
     Returns
     -------
-    list
+    list of SampleAnalysisResults
         A list of SampleAnalysisResults objects, each containing:
-        - modulus_of_elasticity       : Elastic modulus (E_GPa)
-        - ultimate_tensile_strength   : Ultimate tensile strength (UTS_MPa)
-        - yield_Strength              : Yield strength (Yield_Strength_MPa)
+        - sample_name : str
+            Name of the processed sample.
+        - modulus_of_elasticity : float
+            Elastic modulus (E_GPa).
+        - ultimate_tensile_strength : float
+            Ultimate tensile strength (UTS_MPa).
+        - yield_strength : float
+            Yield strength (Yield_Strength_MPa).
     """
     SARS = []
     for Coupon_detail in Coupon_geodata:
@@ -271,7 +284,7 @@ def coupon_results_save(Excelfile_name: str, analysis_results: list):
     print('The coupon test data analysis is complete.')
 
 from dataclasses import dataclass
-@dataclass # this thing is called a "decorator"
+@dataclass
 class coupon_SampleDetails:
     """
     Holds basic information for a sample.
@@ -292,7 +305,7 @@ class coupon_SampleDetails:
     thickness: float
     sample_file_name: str
 
-@dataclass # this thing is called a "decorator"
+@dataclass
 class coupon_SampleAnalysisResults:
     """
     Stores the analysis results for a sample after mechanical testing.

{struct_post-0.1.5 → struct_post-0.1.8}/struct_post.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: struct_post
-Version: 0.1.5
+Version: 0.1.8
 Summary: A module designed to analyse common structural test results.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -8,6 +8,13 @@ License-File: LICENSE
 Requires-Dist: matplotlib>=3.10.6
 Requires-Dist: openpyxl>=3.1.5
 Requires-Dist: pandas>=2.3.2
+Requires-Dist: requests>=2.32.5
+Provides-Extra: doc
+Requires-Dist: sphinx>=8.0; extra == "doc"
+Requires-Dist: myst-parser>=4.0.1; extra == "doc"
+Requires-Dist: nbsphinx>=0.9.7; extra == "doc"
+Requires-Dist: pydata-sphinx-theme>=0.16.1; extra == "doc"
+Requires-Dist: ipykernel>=6.30.1; extra == "doc"
 Dynamic: license-file
 
 # struct_post

struct_post-0.1.8/struct_post.egg-info/requires.txt

@@ -0,0 +1,11 @@
+matplotlib>=3.10.6
+openpyxl>=3.1.5
+pandas>=2.3.2
+requests>=2.32.5
+
+[doc]
+sphinx>=8.0
+myst-parser>=4.0.1
+nbsphinx>=0.9.7
+pydata-sphinx-theme>=0.16.1
+ipykernel>=6.30.1

struct_post-0.1.5/struct_post/beam.py

@@ -1,49 +0,0 @@
-from pandas import DataFrame
-def four_point_bending (data: DataFrame, 
-                        width: float, 
-                        depth: float, 
-                        beam_span: float):
-    import pandas as pd
-    import numpy as np
-
-    #geo
-    sample_name = data[1]
-    force = data[0]['Moog Force_kN'] * 1000
-    delta_1 = abs(data[0]['LVDT 1_mm'])
-    delta_2 = abs(data[0]['LVDT 2_mm'])
-    delta_3 = abs(data[0]['LVDT 3_mm'])
-    delta_4 = abs(data[0]['LVDT 4_mm'])
-    delta_5 = abs(data[0]['LVDT 5_mm'])
-    delta_6 = abs(data[0]['LVDT 6_mm'])
-
-    F_ult = force.max()
-    f_b = (F_ult * beam_span) / (width * depth **2) #MPa
-
-    
-    delta_ms = (delta_3 + delta_4)/2
-    delta_rel = delta_ms - (delta_1 + delta_2 + delta_5 + delta_6) / 4
-    
-    
-    lower_bound = 0.1 * F_ult
-    upper_bound = 0.4 * F_ult
-
-    calcs_reg = (lower_bound <= force) & (force <= upper_bound)
-    
-    F_ms = force[calcs_reg]
-    delta_ms_calcs = delta_ms[calcs_reg]
-    delat_rel_calcs = delta_rel[calcs_reg]
-    
-    Delta_ms, intercept_ms = np.polyfit(delta_ms_calcs,F_ms,1)
-    Delta_rel, intercept_rel = np.polyfit(delat_rel_calcs,F_ms,1)
-    
-    E_app = (23/108) * (beam_span/depth)**3 * Delta_ms * (1/width)
-    E_true = (1/36) *  (beam_span/depth)**3 * Delta_rel * (1/width)
-    
-    results = {
-        "E_app": E_app,
-        "E_true": E_true,
-    }
-
-    print(f"Sample Name: {sample_name}")
-    print('-' * 40)
-    return sample_name, results

struct_post-0.1.5/struct_post.egg-info/requires.txt

@@ -1,3 +0,0 @@
-matplotlib>=3.10.6
-openpyxl>=3.1.5
-pandas>=2.3.2