weac 3.0.1__tar.gz → 3.0.2__tar.gz

{weac-3.0.1 → weac-3.0.2}/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.0.2
 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.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: weac
-Version: 3.0.1
+Version: 3.0.2
 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.0.2}/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.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "weac"
-version = "3.0.1"
+version = "3.0.2"
 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.0.2"
 
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"

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

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

{weac-3.0.1 → weac-3.0.2}/src/weac/analysis/criteria_evaluator.py

@@ -9,7 +9,6 @@ import logging
 import time
 import warnings
 from dataclasses import dataclass
-from typing import List, Optional, Union
 
 # Third party imports
 import numpy as np
@@ -34,12 +33,12 @@ logger = logging.getLogger(__name__)
 class CoupledCriterionHistory:
     """Stores the history of the coupled criterion evaluation."""
 
-    skier_weights: List[float]
-    crack_lengths: List[float]
-    incr_energies: List[np.ndarray]
-    g_deltas: List[float]
-    dist_maxs: List[float]
-    dist_mins: List[float]
+    skier_weights: list[float]
+    crack_lengths: list[float]
+    incr_energies: list[np.ndarray]
+    g_deltas: list[float]
+    dist_maxs: list[float]
+    dist_mins: list[float]
 
 
 @dataclass
@@ -89,7 +88,7 @@ class CoupledCriterionResult:
     g_delta: float
     dist_ERR_envelope: float
     iterations: int
-    history: Optional[CoupledCriterionHistory]
+    history: CoupledCriterionHistory | None
     final_system: SystemModel
     max_dist_stress: float
     min_dist_stress: float
@@ -130,9 +129,9 @@ class FindMinimumForceResult:
         Whether the algorithm converged.
     critical_skier_weight : float
         The critical skier weight.
-    new_segments : List[Segment]
+    new_segments : list[Segment]
         The new segments.
-    old_segments : List[Segment]
+    old_segments : list[Segment]
         The old segments.
     iterations : int
         The number of iterations.
@@ -144,9 +143,9 @@ class FindMinimumForceResult:
 
     success: bool
     critical_skier_weight: float
-    new_segments: List[Segment]
-    old_segments: List[Segment]
-    iterations: Optional[int]
+    new_segments: list[Segment]
+    old_segments: list[Segment]
+    iterations: int | None
     max_dist_stress: float
     min_dist_stress: float
 
@@ -203,10 +202,10 @@ class CriteriaEvaluator:
 
     def stress_envelope(
         self,
-        sigma: Union[float, np.ndarray],
-        tau: Union[float, np.ndarray],
+        sigma: float | np.ndarray,
+        tau: float | np.ndarray,
         weak_layer: WeakLayer,
-        method: Optional[str] = None,
+        method: str | None = None,
     ) -> np.ndarray:
         """
         Evaluate the stress envelope for given stress components.
@@ -672,16 +671,20 @@ class CriteriaEvaluator:
                 UserWarning,
             )
         system_copy = copy.deepcopy(system)
+        system_copy.config.touchdown = True
+        system_copy.update_scenario(scenario_config=ScenarioConfig(phi=0.0))
+        l_BC = system.slab_touchdown.l_BC
+
         segments = [
             Segment(length=5e3, has_foundation=True, m=0.0),
-            Segment(length=5e3, has_foundation=False, m=0.0),
+            Segment(length=2 * l_BC, has_foundation=False, m=0.0),
         ]
         scenario_config = ScenarioConfig(
             system_type="vpst-" if vertical else "pst-",
-            phi=system.scenario.phi,
-            cut_length=5e3,
+            phi=0.0,  # Slab Touchdown works only for flat slab
+            cut_length=2 * l_BC,
         )
-        system_copy.config.touchdown = True
+        # system_copy.config.touchdown = True
         system_copy.update_scenario(segments=segments, scenario_config=scenario_config)
         touchdown_distance = system_copy.slab_touchdown.touchdown_distance
         analyzer = Analyzer(system_copy, printing_enabled=print_call_stats)
@@ -825,7 +828,7 @@ class CriteriaEvaluator:
         system: SystemModel,
         search_interval: tuple[float, float] | None = None,
         target: float = 1,
-    ) -> tuple[float, List[Segment]]:
+    ) -> tuple[float, list[Segment]]:
         """
         Finds the minimum crack length required to surpass the energy release rate envelope.
 
@@ -838,7 +841,7 @@ class CriteriaEvaluator:
         --------
         minimum_crack_length: float
             The minimum crack length required to surpass the energy release rate envelope [mm]
-        new_segments: List[Segment]
+        new_segments: list[Segment]
             The updated list of segments
         """
         old_segments = copy.deepcopy(system.scenario.segments)
@@ -928,7 +931,7 @@ class CriteriaEvaluator:
         self,
         system: SystemModel,
         skier_weight: float,
-    ) -> tuple[float, List[Segment]]:
+    ) -> tuple[float, list[Segment]]:
         """
         Finds the resulting anticrack length and updated segment configurations
         for a given skier weight.
@@ -944,7 +947,7 @@ class CriteriaEvaluator:
         -------
         new_crack_length: float
             The total length of the new cracked segments [mm]
-        new_segments: List[Segment]
+        new_segments: list[Segment]
             The updated list of segments
         """
         logger.info(
@@ -1086,7 +1089,7 @@ class CriteriaEvaluator:
 
     def _find_stress_envelope_crossings(
         self, system: SystemModel, weak_layer: WeakLayer
-    ) -> List[float]:
+    ) -> list[float]:
         """
         Finds the exact x-coordinates where the stress envelope is crossed.
         """

{weac-3.0.1 → weac-3.0.2}/src/weac/analysis/plotter.py

@@ -6,7 +6,7 @@ This module provides plotting functions for visualizing the results of the WEAC
 import colorsys
 import logging
 import os
-from typing import List, Literal, Optional
+from typing import Literal
 
 # Third party imports
 import matplotlib.colors as mc
@@ -219,9 +219,9 @@ class Plotter:
 
     def _get_systems_to_plot(
         self,
-        system_model: Optional[SystemModel] = None,
-        system_models: Optional[List[SystemModel]] = None,
-    ) -> List[SystemModel]:
+        system_model: SystemModel | None = None,
+        system_models: list[SystemModel] | None = None,
+    ) -> list[SystemModel]:
         """Determine which systems to plot based on override parameters."""
         if system_model is not None and system_models is not None:
             raise ValueError(
@@ -236,7 +236,7 @@ class Plotter:
             "SystemModel or list of SystemModels"
         )
 
-    def _save_figure(self, filename: str, fig: Optional[Figure] = None):
+    def _save_figure(self, filename: str, fig: Figure | None = None):
         """Save figure with proper formatting."""
         if fig is None:
             fig = plt.gcf()
@@ -249,20 +249,20 @@ class Plotter:
 
     def plot_slab_profile(
         self,
-        weak_layers: List[WeakLayer] | WeakLayer,
-        slabs: List[Slab] | Slab,
+        weak_layers: list[WeakLayer] | WeakLayer,
+        slabs: list[Slab] | Slab,
         filename: str = "slab_profile",
-        labels: Optional[List[str] | str] = None,
-        colors: Optional[List[str]] = None,
+        labels: list[str] | str | None = None,
+        colors: list[str] | None = None,
     ):
         """
         Plot slab layer profiles for comparison.
 
         Parameters
         ----------
-        weak_layers : List[WeakLayer] | WeakLayer
+        weak_layers : list[WeakLayer] | WeakLayer
             The weak layer or layers to plot.
-        slabs : List[Slab] | Slab
+        slabs : list[Slab] | Slab
             The slab or slabs to plot.
         filename : str, optional
             Filename for saving plot
@@ -281,6 +281,9 @@ class Plotter:
         if isinstance(slabs, Slab):
             slabs = [slabs]
 
+        if len(weak_layers) != len(slabs):
+            raise ValueError("Number of weak layers must match number of slabs")
+
         if labels is None:
             labels = [f"System {i + 1}" for i in range(len(weak_layers))]
         elif isinstance(labels, str):
@@ -642,11 +645,11 @@ class Plotter:
 
     def plot_section_forces(
         self,
-        system_model: Optional[SystemModel] = None,
-        system_models: Optional[List[SystemModel]] = None,
+        system_model: SystemModel | None = None,
+        system_models: list[SystemModel] | None = None,
         filename: str = "section_forces",
-        labels: Optional[List[str]] = None,
-        colors: Optional[List[str]] = None,
+        labels: list[str] | None = None,
+        colors: list[str] | None = None,
     ):
         """
         Plot section forces (N, M, V) for comparison.
@@ -655,7 +658,7 @@ class Plotter:
         ----------
         system_model : SystemModel, optional
             Single system to plot (overrides default)
-        system_models : List[SystemModel], optional
+        system_models : list[SystemModel], optional
             Multiple systems to plot (overrides default)
         filename : str, optional
             Filename for saving plot
@@ -721,11 +724,11 @@ class Plotter:
 
     def plot_energy_release_rates(
         self,
-        system_model: Optional[SystemModel] = None,
-        system_models: Optional[List[SystemModel]] = None,
+        system_model: SystemModel | None = None,
+        system_models: list[SystemModel] | None = None,
         filename: str = "ERR",
-        labels: Optional[List[str]] = None,
-        colors: Optional[List[str]] = None,
+        labels: list[str] | None = None,
+        colors: list[str] | None = None,
     ):
         """
         Plot energy release rates (G_I, G_II) for comparison.
@@ -734,7 +737,7 @@ class Plotter:
         ----------
         system_model : SystemModel, optional
             Single system to plot (overrides default)
-        system_models : List[SystemModel], optional
+        system_models : list[SystemModel], optional
             Multiple systems to plot (overrides default)
         filename : str, optional
             Filename for saving plot
@@ -1035,7 +1038,7 @@ class Plotter:
         system_model: SystemModel,
         criteria_evaluator: CriteriaEvaluator,
         all_envelopes: bool = False,
-        filename: Optional[str] = None,
+        filename: str | None = None,
     ):
         """
         Plot stress envelope in τ-σ space.
@@ -1074,7 +1077,7 @@ class Plotter:
         weak_layer = system_model.weak_layer
 
         # Define a function to find the root for a given tau
-        def find_sigma_for_tau(tau_val, sigma_c, method: Optional[str] = None):
+        def find_sigma_for_tau(tau_val, sigma_c, method: str | None = None):
             # Target function to find the root of: envelope(sigma, tau) - 1 = 0
             def envelope_root_func(sigma_val):
                 return (

{weac-3.0.1 → weac-3.0.2}/src/weac/components/model_input.py

@@ -14,7 +14,6 @@ field_name: type = Field(..., gt=0, description="Description")
 
 import json
 import logging
-from typing import List
 
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 
@@ -49,13 +48,13 @@ class ModelInput(BaseModel):
         default_factory=lambda: WeakLayer(rho=125, h=20, E=1.0),
         description="Weak layer",
     )
-    layers: List[Layer] = Field(
-        default_factory=lambda: [Layer(rho=250, h=100)], description="List of layers"
+    layers: list[Layer] = Field(
+        default_factory=lambda: [Layer(rho=250, h=100)], description="list of layers"
     )
     scenario_config: ScenarioConfig = Field(
         default_factory=ScenarioConfig, description="Scenario configuration"
     )
-    segments: List[Segment] = Field(
+    segments: list[Segment] = Field(
         default_factory=lambda: [
             Segment(length=5000, has_foundation=True, m=100),
             Segment(length=5000, has_foundation=True, m=0),