weac 3.0.1__tar.gz → 3.1.0__tar.gz

{weac-3.0.1 → weac-3.1.0}/CITATION.cff

@@ -8,7 +8,7 @@ authors:
 - family-names: "Weissgraeber"
   given-names: "Philipp"
   orcid: "https://orcid.org/0000-0001-8320-8672"
-version: 3.0.1
+version: 3.1.0
 date-released: 2021-12-30
 identifiers:
   - description: Collection of archived snapshots of all versions of WEAC

{weac-3.0.1/src/weac.egg-info → weac-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: weac
-Version: 3.0.1
+Version: 3.1.0
 Summary: Weak layer anticrack nucleation model
 Author-email: 2phi GbR <mail@2phi.de>
 License-Expression: MIT
@@ -35,6 +35,9 @@ Requires-Dist: traitlets>=5.14.3; extra == "interactive"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinxawesome-theme; extra == "docs"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
 Provides-Extra: dev
 Requires-Dist: nbclient>=0.10.0; extra == "dev"
 Requires-Dist: nbconvert>=7.16.4; extra == "dev"
@@ -55,7 +58,6 @@ Requires-Dist: pycodestyle>=2.11.1; extra == "dev"
 Requires-Dist: black>=24.4.0; extra == "dev"
 Requires-Dist: isort>=5.13.0; extra == "dev"
 Requires-Dist: bump-my-version; extra == "dev"
-Requires-Dist: build; extra == "dev"
 Dynamic: license-file
 
 <!-- LOGO AND TITLE-->
@@ -128,12 +130,13 @@ Dynamic: license-file
 
 1. [About the project](#about-the-project)
 2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Roadmap](#roadmap)
-5. [Release history](#release-history)
-6. [How to contribute](#how-to-contribute)
-7. [License](#license)
-8. [Contact](#contact)
+3. [Development Setup](#development-setup)
+4. [Usage](#usage)
+5. [Roadmap](#roadmap)
+6. [Release history](#release-history)
+7. [How to contribute](#how-to-contribute)
+8. [License](#license)
+9. [Contact](#contact)
 
 <!-- ABOUT THE PROJECT -->
 ## About the project
@@ -189,6 +192,100 @@ Needs (runtime dependencies are declared in [pyproject.toml](https://github.com/
 - [Snowpylot](https://github.com/connellymk/snowpylot) ≥ 1.1.3
 
 
+<!-- DEVELOPMENT SETUP -->
+## Development Setup
+
+This project uses [uv](https://github.com/astral-sh/uv) for fast Python package management and project handling.
+
+### Installing uv
+
+Install uv following the [official installation guide](https://github.com/astral-sh/uv#installation):
+
+```bash
+# On macOS and Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Using pip (alternative)
+pip install uv
+```
+
+### Setting up the development environment
+
+Clone the repository and set up the development environment:
+
+```bash
+git clone https://github.com/2phi/weac
+cd weac
+
+# Install Python 3.12+ if not already available
+# uv will automatically use the version specified in .python-version
+
+# For basic setup (if only running the package):
+uv sync
+
+# For development (recommended for contributors):
+uv sync --extra dev
+
+# Activate the virtual environment
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+```
+
+### Running tests
+
+Run the test suite using uv:
+
+```bash
+# Run all tests
+uv run python tests/run_tests.py
+
+# Or use pytest directly (if installed)
+uv run pytest
+```
+
+### Code formatting and linting
+
+This project uses [ruff](https://github.com/astral-sh/ruff) for fast Python linting and formatting:
+
+```bash
+# Format code
+uv run ruff format .
+
+# Check for linting issues
+uv run ruff check .
+
+# Fix auto-fixable linting issues
+uv run ruff check . --fix
+```
+
+### Building the package
+
+Build the package for distribution:
+
+```bash
+# Build wheel and source distribution
+uv build
+
+# Install in editable mode for development
+uv pip install -e .
+```
+
+### Additional uv commands
+
+```bash
+# Update dependencies
+uv sync --upgrade
+
+# Add a new dependency
+uv add package-name
+
+# Add a development dependency
+uv add --dev package-name
+
+# Show environment info
+uv run python --version
+uv run pip list
+```
+
 <!-- USAGE EXAMPLES -->
 ## Usage
 

{weac-3.0.1 → weac-3.1.0}/README.md

@@ -68,12 +68,13 @@
 
 1. [About the project](#about-the-project)
 2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Roadmap](#roadmap)
-5. [Release history](#release-history)
-6. [How to contribute](#how-to-contribute)
-7. [License](#license)
-8. [Contact](#contact)
+3. [Development Setup](#development-setup)
+4. [Usage](#usage)
+5. [Roadmap](#roadmap)
+6. [Release history](#release-history)
+7. [How to contribute](#how-to-contribute)
+8. [License](#license)
+9. [Contact](#contact)
 
 <!-- ABOUT THE PROJECT -->
 ## About the project
@@ -129,6 +130,100 @@ Needs (runtime dependencies are declared in [pyproject.toml](https://github.com/
 - [Snowpylot](https://github.com/connellymk/snowpylot) ≥ 1.1.3
 
 
+<!-- DEVELOPMENT SETUP -->
+## Development Setup
+
+This project uses [uv](https://github.com/astral-sh/uv) for fast Python package management and project handling.
+
+### Installing uv
+
+Install uv following the [official installation guide](https://github.com/astral-sh/uv#installation):
+
+```bash
+# On macOS and Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Using pip (alternative)
+pip install uv
+```
+
+### Setting up the development environment
+
+Clone the repository and set up the development environment:
+
+```bash
+git clone https://github.com/2phi/weac
+cd weac
+
+# Install Python 3.12+ if not already available
+# uv will automatically use the version specified in .python-version
+
+# For basic setup (if only running the package):
+uv sync
+
+# For development (recommended for contributors):
+uv sync --extra dev
+
+# Activate the virtual environment
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+```
+
+### Running tests
+
+Run the test suite using uv:
+
+```bash
+# Run all tests
+uv run python tests/run_tests.py
+
+# Or use pytest directly (if installed)
+uv run pytest
+```
+
+### Code formatting and linting
+
+This project uses [ruff](https://github.com/astral-sh/ruff) for fast Python linting and formatting:
+
+```bash
+# Format code
+uv run ruff format .
+
+# Check for linting issues
+uv run ruff check .
+
+# Fix auto-fixable linting issues
+uv run ruff check . --fix
+```
+
+### Building the package
+
+Build the package for distribution:
+
+```bash
+# Build wheel and source distribution
+uv build
+
+# Install in editable mode for development
+uv pip install -e .
+```
+
+### Additional uv commands
+
+```bash
+# Update dependencies
+uv sync --upgrade
+
+# Add a new dependency
+uv add package-name
+
+# Add a development dependency
+uv add --dev package-name
+
+# Show environment info
+uv run python --version
+uv run pip list
+```
+
 <!-- USAGE EXAMPLES -->
 ## Usage
 

{weac-3.0.1 → weac-3.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "weac"
-version = "3.0.1"
+version = "3.1.0"
 authors = [{ name = "2phi GbR", email = "mail@2phi.de" }]
 description = "Weak layer anticrack nucleation model"
 readme = "README.md"
@@ -46,6 +46,7 @@ interactive = [
     "traitlets>=5.14.3",
 ]
 docs = ["sphinx", "sphinxawesome-theme"]
+build = ["build", "twine"]
 dev = [
     # Notebook execution (to run demo.ipynb non-interactively)
     "nbclient>=0.10.0",
@@ -73,9 +74,6 @@ dev = [
 
     # Versioning helper matching [tool.bumpversion]
     "bump-my-version", # e.g. bump-my-version bump patch
-
-    # Building for Testing
-    "build",
 ]
 
 [tool.setuptools]
@@ -125,7 +123,7 @@ ignore = [
 ]
 
 [tool.bumpversion]
-current_version = "3.0.1"
+current_version = "3.1.0"
 
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"

{weac-3.0.1 → weac-3.1.0}/src/weac/__init__.py

@@ -2,4 +2,4 @@
 WEAC - Weak Layer Anticrack Nucleation Model
 """
 
-__version__ = "3.0.1"
+__version__ = "3.1.0"

{weac-3.0.1 → weac-3.1.0}/src/weac/analysis/__init__.py

@@ -8,7 +8,7 @@ from .criteria_evaluator import (
     CoupledCriterionResult,
     CriteriaEvaluator,
     FindMinimumForceResult,
-    SSERRResult,
+    SteadyStateResult,
 )
 from .plotter import Plotter
 
@@ -18,6 +18,6 @@ __all__ = [
     "CoupledCriterionHistory",
     "CoupledCriterionResult",
     "FindMinimumForceResult",
-    "SSERRResult",
+    "SteadyStateResult",
     "Plotter",
 ]

{weac-3.0.1 → weac-3.1.0}/src/weac/analysis/analyzer.py

@@ -214,7 +214,7 @@ class Analyzer:
             ],  # Convert to t/mm^3
             "tensile_strength": [
                 layer.tensile_strength for layer in self.sm.slab.layers
-            ],
+            ],  # in kPa
         }
 
         # Repeat properties for each grid point in the layer
@@ -225,7 +225,7 @@ class Analyzer:
         return si
 
     @track_analyzer_call
-    def Sxx(self, Z, phi, dz=2, unit="kPa"):
+    def Sxx(self, Z, phi, dz=2, unit="kPa", normalize: bool = False):
         """
         Compute axial normal stress in slab layers.
 
@@ -239,6 +239,10 @@ class Analyzer:
             Element size along z-axis (mm). Default is 2 mm.
         unit : {'kPa', 'MPa'}, optional
             Desired output unit. Default is 'kPa'.
+        normalize : bool, optional
+            Toggle normalization. If True, normalize stress values to the tensile strength of each layer (dimensionless).
+            When normalized, the `unit` parameter is ignored and values are returned as ratios.
+            Default is False.
 
         Returns
         -------
@@ -258,13 +262,13 @@ class Analyzer:
         m = Z.shape[1]
 
         # Initialize axial normal stress Sxx
-        Sxx = np.zeros(shape=[n, m])
+        Sxx_MPa = np.zeros(shape=[n, m])
 
         # Compute axial normal stress Sxx at grid points in MPa
         for i, z in enumerate(zi):
-            E = zmesh["E"][i]
+            E_MPa = zmesh["E"][i]
             nu = zmesh["nu"][i]
-            Sxx[i, :] = E / (1 - nu**2) * self.sm.fq.du_dx(Z, z)
+            Sxx_MPa[i, :] = E_MPa / (1 - nu**2) * self.sm.fq.du_dx(Z, z)
 
         # Calculate weight load at grid points and superimpose on stress field
         qt = -rho * G_MM_S2 * np.sin(np.deg2rad(phi))
@@ -274,14 +278,22 @@ class Analyzer:
         # Sxx[-1, :] += qt[-1] * (zi[-1] - zi[-2])
         # New Implementation: Changed for numerical stability
         dz = np.diff(zi)
-        Sxx[:-1, :] += qt[:-1, np.newaxis] * dz[:, np.newaxis]
-        Sxx[-1, :] += qt[-1] * dz[-1]
+        Sxx_MPa[:-1, :] += qt[:-1, np.newaxis] * dz[:, np.newaxis]
+        Sxx_MPa[-1, :] += qt[-1] * dz[-1]
+
+        # Normalize tensile stresses to tensile strength
+        if normalize:
+            tensile_strength_kPa = zmesh["tensile_strength"]
+            tensile_strength_MPa = tensile_strength_kPa / 1e3
+            # Normalize axial normal stress to layers' tensile strength
+            normalized_Sxx = Sxx_MPa / tensile_strength_MPa[:, None]
+            return normalized_Sxx
 
         # Return axial normal stress in specified unit
-        return convert[unit] * Sxx
+        return convert[unit] * Sxx_MPa
 
     @track_analyzer_call
-    def Txz(self, Z, phi, dz=2, unit="kPa"):
+    def Txz(self, Z, phi, dz=2, unit="kPa", normalize: bool = False):
         """
         Compute shear stress in slab layers.
 
@@ -295,6 +307,9 @@ class Analyzer:
             Element size along z-axis (mm). Default is 2 mm.
         unit : {'kPa', 'MPa'}, optional
             Desired output unit. Default is 'kPa'.
+        normalize : bool, optional
+            Toggle normalization.  If True, normalize shear stress values to the tensile strength of each layer (dimensionless).
+            When normalized, the `unit` parameter is ignored and values are returned as ratios. Default is False.
 
         Returns
         -------
@@ -332,14 +347,22 @@ class Analyzer:
 
         # Integrate -dsxx_dx along z and add cumulative weight load
         # to obtain shear stress Txz in MPa
-        Txz = cumulative_trapezoid(dsxx_dx, zi, axis=0, initial=0)
-        Txz += cumulative_trapezoid(qt, zi, initial=0)[:, None]
+        Txz_MPa = cumulative_trapezoid(dsxx_dx, zi, axis=0, initial=0)
+        Txz_MPa += cumulative_trapezoid(qt, zi, initial=0)[:, None]
+
+        # Normalize shear stresses to tensile strength
+        if normalize:
+            tensile_strength_kPa = zmesh["tensile_strength"]
+            tensile_strength_MPa = tensile_strength_kPa / 1e3
+            # Normalize shear stress to layers' tensile strength
+            normalized_Txz = Txz_MPa / tensile_strength_MPa[:, None]
+            return normalized_Txz
 
         # Return shear stress Txz in specified unit
-        return convert[unit] * Txz
+        return convert[unit] * Txz_MPa
 
     @track_analyzer_call
-    def Szz(self, Z, phi, dz=2, unit="kPa"):
+    def Szz(self, Z, phi, dz=2, unit="kPa", normalize: bool = False):
         """
         Compute transverse normal stress in slab layers.
 
@@ -353,6 +376,10 @@ class Analyzer:
             Element size along z-axis (mm). Default is 2 mm.
         unit : {'kPa', 'MPa'}, optional
             Desired output unit. Default is 'kPa'.
+        normalize : bool, optional
+            Toggle normalization. If True, normalize stress values to the tensile strength of each layer (dimensionless).
+            When normalized, the `unit` parameter is ignored and values are returned as ratios.
+            Default is False.
 
         Returns
         -------
@@ -392,11 +419,19 @@ class Analyzer:
         # Integrate dsxx_dxdx twice along z to obtain transverse
         # normal stress Szz in MPa
         integrand = cumulative_trapezoid(dsxx_dxdx, zi, axis=0, initial=0)
-        Szz = cumulative_trapezoid(integrand, zi, axis=0, initial=0)
-        Szz += cumulative_trapezoid(-qn, zi, initial=0)[:, None]
+        Szz_MPa = cumulative_trapezoid(integrand, zi, axis=0, initial=0)
+        Szz_MPa += cumulative_trapezoid(-qn, zi, initial=0)[:, None]
 
-        # Return shear stress txz in specified unit
-        return convert[unit] * Szz
+        # Normalize tensile stresses to tensile strength
+        if normalize:
+            tensile_strength_kPa = zmesh["tensile_strength"]
+            tensile_strength_MPa = tensile_strength_kPa / 1e3
+            # Normalize transverse normal stress to layers' tensile strength
+            normalized_Szz = Szz_MPa / tensile_strength_MPa[:, None]
+            return normalized_Szz
+
+        # Return transverse normal stress Szz in specified unit
+        return convert[unit] * Szz_MPa
 
     @track_analyzer_call
     def principal_stress_slab(
@@ -438,6 +473,8 @@ class Analyzer:
             'min', or if normalization of compressive principal stress
             is requested.
         """
+        convert = {"kPa": 1e3, "MPa": 1}
+
         # Raise error if specified component is not available
         if val not in ["min", "max"]:
             raise ValueError(f"Component {val} not defined.")
@@ -460,9 +497,10 @@ class Analyzer:
         # Normalize tensile stresses to tensile strength
         if normalize and val == "max":
             zmesh = self.get_zmesh(dz=dz)
-            tensile_strength = zmesh["tensile_strength"]
+            tensile_strength_kPa = zmesh["tensile_strength"]
+            tensile_strength_converted = tensile_strength_kPa / 1e3 * convert[unit]
             # Normalize maximum principal stress to layers' tensile strength
-            normalized_Ps = Ps / tensile_strength[:, None]
+            normalized_Ps = Ps / tensile_strength_converted[:, None]
             return normalized_Ps
 
         # Return absolute principal stresses