lamkit 0.1.2__tar.gz → 0.1.3__tar.gz

{lamkit-0.1.2 → lamkit-0.1.3}/.gitignore

@@ -1,33 +1,36 @@
-# Python cache and bytecode
-__pycache__/
-*.py[cod]
-*.pyo
-
-# Packaging artifacts
-build/
-dist/
-*.egg-info/
-.eggs/
-
-# Virtual environments
-.venv/
-venv/
-env/
-
-# Test and tooling cache
-.pytest_cache/
-.mypy_cache/
-.ruff_cache/
-.coverage
-htmlcov/
-
-# Sphinx docs build output
-docs/_build/
-
-# IDE
-.idea/
-.vscode/
-
-# Data
-
-data/
+# Python cache and bytecode
+__pycache__/
+*.py[cod]
+*.pyo
+
+# Packaging artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test and tooling cache
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Sphinx docs build output
+docs/_build/
+
+# IDE
+.idea/
+.vscode/
+
+# Data
+
+data/
+
+# For coding/testing purposes
+old/

{lamkit-0.1.2 → lamkit-0.1.3}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Runze LI
-
-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.
+MIT License
+
+Copyright (c) 2026 Runze LI
+
+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.

{lamkit-0.1.2 → lamkit-0.1.3}/MANIFEST.in

@@ -1,3 +1,3 @@
-include README.md
-include LICENSE
-recursive-include docs *.rst *.md *.py *.txt
+include README.md
+include LICENSE
+recursive-include docs *.rst *.md *.py *.txt

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lamkit
-Version: 0.1.2
+Version: 0.1.3
 Summary: Toolkit for stress analysis and failure prediction of composite laminates with holes and joints.
 Project-URL: Homepage, https://github.com/swayli94/lamkit
 Project-URL: Documentation, https://swayli94.github.io/lamkit/
@@ -52,6 +52,7 @@ Requires-Dist: twine>=5.1; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: furo>=2024.8.6; extra == 'docs'
 Requires-Dist: myst-parser>=4.0; extra == 'docs'
+Requires-Dist: scipy>=1.10; extra == 'docs'
 Requires-Dist: sphinx>=8.0; extra == 'docs'
 Description-Content-Type: text/markdown
 
@@ -65,6 +66,7 @@ Description-Content-Type: text/markdown
 - Open-hole plate's effective (homogenisation) properties
 - Linear buckling analysis of laminates
 - Objective/constraint evaluation for laminate optimization tasks
+- Layup engineering-requirement checks and feasibility rating against a layup attribute database
 
 ## Installation
 
@@ -72,6 +74,7 @@ Description-Content-Type: text/markdown
 
 - Python `>=3.9`
 - Core dependencies: `numpy`, `pandas`, `matplotlib`
+- Optional: `scipy` (linear buckling and layup feasibility rating)
 
 ### Install from PyPI
 
@@ -133,6 +136,10 @@ The `example/` directory contains runnable scripts:
    `example/6-laminate-optimization-task/example_laminate_opt_function.py`  
    Demonstrates combined displacement, failure, and buckling constraint evaluation for design tasks.
 
+7. **Layup feasibility rating**  
+   `example/7-layup-feasibility/example_layup_feasibility.py`  
+   Scores a candidate stacking (ply counts, bending lamination parameters) by distance to the nearest layups in a CSV database.
+
 ## Common Development Commands
 
 ### Run tests

{lamkit-0.1.2 → lamkit-0.1.3}/README.md

@@ -1,98 +1,104 @@
-# lamkit
-
-`lamkit` is a Python toolkit for composite laminate analysis, focused on:
-
-- Laminate stress/strain response based on Classical Lamination Theory (CLT)
-- LaRC05 failure index evaluation
-- Lekhnitskii open-hole infinite-plate analytical solution
-- Open-hole plate's effective (homogenisation) properties
-- Linear buckling analysis of laminates
-- Objective/constraint evaluation for laminate optimization tasks
-
-## Installation
-
-### Requirements
-
-- Python `>=3.9`
-- Core dependencies: `numpy`, `pandas`, `matplotlib`
-
-### Install from PyPI
-
-```bash
-pip install lamkit
-```
-
-### Install for local development
-
-```bash
-pip install -e .[dev,docs]
-```
-
-## Quick Start
-
-The following example creates a laminate and evaluates ply-surface fields under membrane loading:
-
-```python
-import numpy as np
-from lamkit import Laminate, Ply
-from lamkit.analysis.material import IM7_8551_7
-
-ply = Ply(IM7_8551_7, thickness=0.125)  # mm
-stacking = [45, -45, 0, 90, 90, 0, -45, 45]
-laminate = Laminate(stacking=stacking, plies=ply)
-
-# N = [Nxx, Nyy, Nxy, Mxx, Myy, Mxy]
-N = np.array([80.0, 0.0, 0.0, 0.0, 0.0, 0.0])
-field = laminate.evaluate_laminate(N)
-
-print(field[["index_ply", "index_surface", "z", "sigma_1", "sigma_2", "tau_12", "FI_max"]].head())
-```
-
-## Examples
-
-The `example/` directory contains runnable scripts:
-
-1. **Laminate response (CLT + LaRC05)**  
-   `example/1-laminate/example_laminate.py`  
-   Computes through-thickness stress/strain and LaRC05 index distributions with plots.
-
-2. **Lekhnitskii unloaded-hole solution**  
-   `example/2-lekhnitskii-solution/example_unloaded_hole.py`  
-   Solves and visualizes open-hole stress fields.
-
-3. **Laminate open-hole field analysis**  
-   `example/3-open-hole/example_open_hole.py`  
-   Couples laminate equivalent compliance with open-hole fields and generates failure envelopes/boundary maps.
-
-4. **Effective stiffness with hole homogenization**  
-   `example/4-effective-stiffness/example_effective_stiffness.py`  
-   Compares laminate stiffness `A` (without hole) and homogenized stiffness `A_eff` (with hole).
-
-5. **Laminate linear buckling**  
-   `example/5-laminate-buckling/example_buckling.py`  
-   Computes buckling eigenvalues and saves buckling mode plots.
-
-6. **Optimization objective/constraint evaluation**  
-   `example/6-laminate-optimization-task/example_laminate_opt_function.py`  
-   Demonstrates combined displacement, failure, and buckling constraint evaluation for design tasks.
-
-## Common Development Commands
-
-### Run tests
-
-```bash
-pytest
-```
-
-### Build distribution package
-
-```bash
-python -m build
-```
-
-### Build documentation
-
-```bash
-cd docs
-sphinx-build -b html . _build/html
-```
+# lamkit
+
+`lamkit` is a Python toolkit for composite laminate analysis, focused on:
+
+- Laminate stress/strain response based on Classical Lamination Theory (CLT)
+- LaRC05 failure index evaluation
+- Lekhnitskii open-hole infinite-plate analytical solution
+- Open-hole plate's effective (homogenisation) properties
+- Linear buckling analysis of laminates
+- Objective/constraint evaluation for laminate optimization tasks
+- Layup engineering-requirement checks and feasibility rating against a layup attribute database
+
+## Installation
+
+### Requirements
+
+- Python `>=3.9`
+- Core dependencies: `numpy`, `pandas`, `matplotlib`
+- Optional: `scipy` (linear buckling and layup feasibility rating)
+
+### Install from PyPI
+
+```bash
+pip install lamkit
+```
+
+### Install for local development
+
+```bash
+pip install -e .[dev,docs]
+```
+
+## Quick Start
+
+The following example creates a laminate and evaluates ply-surface fields under membrane loading:
+
+```python
+import numpy as np
+from lamkit import Laminate, Ply
+from lamkit.analysis.material import IM7_8551_7
+
+ply = Ply(IM7_8551_7, thickness=0.125)  # mm
+stacking = [45, -45, 0, 90, 90, 0, -45, 45]
+laminate = Laminate(stacking=stacking, plies=ply)
+
+# N = [Nxx, Nyy, Nxy, Mxx, Myy, Mxy]
+N = np.array([80.0, 0.0, 0.0, 0.0, 0.0, 0.0])
+field = laminate.evaluate_laminate(N)
+
+print(field[["index_ply", "index_surface", "z", "sigma_1", "sigma_2", "tau_12", "FI_max"]].head())
+```
+
+## Examples
+
+The `example/` directory contains runnable scripts:
+
+1. **Laminate response (CLT + LaRC05)**  
+   `example/1-laminate/example_laminate.py`  
+   Computes through-thickness stress/strain and LaRC05 index distributions with plots.
+
+2. **Lekhnitskii unloaded-hole solution**  
+   `example/2-lekhnitskii-solution/example_unloaded_hole.py`  
+   Solves and visualizes open-hole stress fields.
+
+3. **Laminate open-hole field analysis**  
+   `example/3-open-hole/example_open_hole.py`  
+   Couples laminate equivalent compliance with open-hole fields and generates failure envelopes/boundary maps.
+
+4. **Effective stiffness with hole homogenization**  
+   `example/4-effective-stiffness/example_effective_stiffness.py`  
+   Compares laminate stiffness `A` (without hole) and homogenized stiffness `A_eff` (with hole).
+
+5. **Laminate linear buckling**  
+   `example/5-laminate-buckling/example_buckling.py`  
+   Computes buckling eigenvalues and saves buckling mode plots.
+
+6. **Optimization objective/constraint evaluation**  
+   `example/6-laminate-optimization-task/example_laminate_opt_function.py`  
+   Demonstrates combined displacement, failure, and buckling constraint evaluation for design tasks.
+
+7. **Layup feasibility rating**  
+   `example/7-layup-feasibility/example_layup_feasibility.py`  
+   Scores a candidate stacking (ply counts, bending lamination parameters) by distance to the nearest layups in a CSV database.
+
+## Common Development Commands
+
+### Run tests
+
+```bash
+pytest
+```
+
+### Build distribution package
+
+```bash
+python -m build
+```
+
+### Build documentation
+
+```bash
+cd docs
+sphinx-build -b html . _build/html
+```

{lamkit-0.1.2 → lamkit-0.1.3}/docs/Makefile

@@ -1,16 +1,16 @@
-# Minimal makefile for Sphinx docs.
-
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-.PHONY: help clean html
-
-help:
-	$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)"
-
-clean:
-	rm -rf "$(BUILDDIR)"
-
-html:
-	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"
+# Minimal makefile for Sphinx docs.
+
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+.PHONY: help clean html
+
+help:
+	$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)"
+
+clean:
+	rm -rf "$(BUILDDIR)"
+
+html:
+	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"

{lamkit-0.1.2 → lamkit-0.1.3}/docs/_static/.gitkeep

@@ -1 +1 @@
-
+

{lamkit-0.1.2 → lamkit-0.1.3}/docs/_templates/.gitkeep

@@ -1 +1 @@
-
+

{lamkit-0.1.2 → lamkit-0.1.3}/docs/api.rst

@@ -1,69 +1,77 @@
-API reference
-=============
-
-Top-level package
------------------
-
-.. automodule:: lamkit
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Analysis
---------
-
-.. automodule:: lamkit.analysis.material
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.analysis.laminate
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.analysis.larc05
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.analysis.buckling
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Lekhnitskii
------------
-
-.. automodule:: lamkit.lekhnitskii.hole
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.lekhnitskii.unloaded_hole
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.lekhnitskii.loaded_hole
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.lekhnitskii.homogenisation
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Utilities and requirements
---------------------------
-
-.. automodule:: lamkit.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: lamkit.requirements
-   :members:
-   :undoc-members:
-   :show-inheritance:
+API reference
+=============
+
+Top-level package
+-----------------
+
+.. automodule:: lamkit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Analysis
+--------
+
+.. automodule:: lamkit.analysis.material
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.analysis.laminate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.analysis.larc05
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.analysis.buckling
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Lekhnitskii
+-----------
+
+.. automodule:: lamkit.lekhnitskii.hole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.lekhnitskii.unloaded_hole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.lekhnitskii.loaded_hole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.lekhnitskii.homogenisation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Layup utilities
+---------------
+
+.. automodule:: lamkit.layup.requirements
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: lamkit.layup.feasibility
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Utilities
+---------
+
+.. automodule:: lamkit.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

lamkit-0.1.3/docs/conf.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import os
+import re
+import sys
+import warnings
+from datetime import datetime
+from importlib.util import find_spec
+
+# Anchor paths to this file so builds work from any cwd (e.g. repo root:
+# ``sphinx-build -b html docs docs/_build/html``).
+_CONF_DIR = os.path.dirname(os.path.abspath(__file__))
+PROJECT_ROOT = os.path.dirname(_CONF_DIR)
+SRC_ROOT = os.path.join(PROJECT_ROOT, "src")
+sys.path.insert(0, SRC_ROOT)
+
+_INIT_PY = os.path.join(SRC_ROOT, "lamkit", "__init__.py")
+with open(_INIT_PY, encoding="utf-8") as _f:
+    _init_src = _f.read()
+_match = re.search(
+    r'^__version__\s*=\s*[\'"]([^\'"]+)[\'"]',
+    _init_src,
+    re.MULTILINE,
+)
+release = _match.group(1) if _match else "0.0.0"
+version = release.rpartition(".")[0] if release.count(".") >= 2 else release
+
+project = "lamkit"
+author = "Runze Li"
+copyright = f"{datetime.now().year}, {author}"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "myst_parser",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+language = "en"
+# Furo is optional at parse time: editors may analyze conf.py without docs extras installed.
+if find_spec("furo") is not None:
+    html_theme = "furo"
+else:
+    html_theme = "alabaster"
+    warnings.warn(
+        "Sphinx theme 'furo' is not installed; using bundled 'alabaster'. "
+        'Install docs extras: pip install -e ".[docs]" or pip install furo',
+        UserWarning,
+        stacklevel=1,
+    )
+html_static_path = ["_static"]
+
+autodoc_member_order = "bysource"
+autodoc_typehints = "description"
+
+# Autodoc imports lamkit modules, which require NumPy, pandas, Matplotlib, SciPy, etc.
+# Install with: pip install -e ".[docs]"  (see docs/installation.rst).