trussme 0.1.0__tar.gz

trussme-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Christopher C. McComb
+
+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.

trussme-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include tests *.py *.trs

trussme-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: trussme
+Version: 0.1.0
+Summary: Truss construction and analysis
+Author-email: Christopher McComb <ccmcc2012@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/cmccomb/TrussMe
+Project-URL: Source, https://github.com/cmccomb/TrussMe
+Project-URL: Issues, https://github.com/cmccomb/TrussMe/issues
+Keywords: truss,structural analysis,optimization,engineering
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: tabulate
+Provides-Extra: dev
+Requires-Dist: build>=1; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=6; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# trussme
+
+`trussme` is a Python library for building, analyzing, and optimizing truss structures.
+
+## Installation
+
+`trussme` supports Python 3.10 and newer.
+
+```bash
+pip install trussme
+```
+
+The package depends on `numpy`, `scipy`, `pandas`, `matplotlib`, and `tabulate` at runtime.
+
+## Quick Start
+
+```python
+import trussme
+
+truss = trussme.Truss()
+pin = truss.add_pinned_joint([0.0, 0.0, 0.0])
+free = truss.add_free_joint([2.5, 2.5, 0.0])
+roller = truss.add_roller_joint([5.0, 0.0, 0.0])
+
+truss.add_member(pin, free)
+truss.add_member(pin, roller)
+truss.add_member(roller, free)
+
+truss.add_out_of_plane_support("z")
+truss.set_load(free, [0.0, -10000.0, 0.0])
+
+truss.analyze()
+
+print(truss.fos)
+print(truss.mass)
+```
+
+## Built-in Materials
+
+Trussme ships with a small library of common engineering materials. Each record
+includes a `source` URL citing where the mechanical properties originate.
+
+- A36_Steel - https://en.wikipedia.org/wiki/A36_steel
+- A992_Steel - https://en.wikipedia.org/wiki/ASTM_A992
+- 304_Stainless_Steel - https://en.wikipedia.org/wiki/SAE_304_stainless_steel
+- 2024_T3_Aluminum - https://en.wikipedia.org/wiki/2024_aluminium_alloy
+- 6061_T6_Aluminum - https://en.wikipedia.org/wiki/6061_aluminium_alloy
+- 7075_T6_Aluminum - https://en.wikipedia.org/wiki/7075_aluminium_alloy
+- Ti_6Al_4V_Titanium - https://en.wikipedia.org/wiki/Ti-6Al-4V
+
+Custom materials must also provide a provenance `source` when added to a truss.
+
+## Project Links
+
+- Source: [GitHub](https://github.com/cmccomb/TrussMe)
+- Issues: [GitHub Issues](https://github.com/cmccomb/TrussMe/issues)
+- Release Guide: [RELEASING.md](RELEASING.md)
+
+## License
+
+This project is released under the MIT License.

trussme-0.1.0/README.md

@@ -0,0 +1,61 @@
+# trussme
+
+`trussme` is a Python library for building, analyzing, and optimizing truss structures.
+
+## Installation
+
+`trussme` supports Python 3.10 and newer.
+
+```bash
+pip install trussme
+```
+
+The package depends on `numpy`, `scipy`, `pandas`, `matplotlib`, and `tabulate` at runtime.
+
+## Quick Start
+
+```python
+import trussme
+
+truss = trussme.Truss()
+pin = truss.add_pinned_joint([0.0, 0.0, 0.0])
+free = truss.add_free_joint([2.5, 2.5, 0.0])
+roller = truss.add_roller_joint([5.0, 0.0, 0.0])
+
+truss.add_member(pin, free)
+truss.add_member(pin, roller)
+truss.add_member(roller, free)
+
+truss.add_out_of_plane_support("z")
+truss.set_load(free, [0.0, -10000.0, 0.0])
+
+truss.analyze()
+
+print(truss.fos)
+print(truss.mass)
+```
+
+## Built-in Materials
+
+Trussme ships with a small library of common engineering materials. Each record
+includes a `source` URL citing where the mechanical properties originate.
+
+- A36_Steel - https://en.wikipedia.org/wiki/A36_steel
+- A992_Steel - https://en.wikipedia.org/wiki/ASTM_A992
+- 304_Stainless_Steel - https://en.wikipedia.org/wiki/SAE_304_stainless_steel
+- 2024_T3_Aluminum - https://en.wikipedia.org/wiki/2024_aluminium_alloy
+- 6061_T6_Aluminum - https://en.wikipedia.org/wiki/6061_aluminium_alloy
+- 7075_T6_Aluminum - https://en.wikipedia.org/wiki/7075_aluminium_alloy
+- Ti_6Al_4V_Titanium - https://en.wikipedia.org/wiki/Ti-6Al-4V
+
+Custom materials must also provide a provenance `source` when added to a truss.
+
+## Project Links
+
+- Source: [GitHub](https://github.com/cmccomb/TrussMe)
+- Issues: [GitHub Issues](https://github.com/cmccomb/TrussMe/issues)
+- Release Guide: [RELEASING.md](RELEASING.md)
+
+## License
+
+This project is released under the MIT License.

trussme-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "trussme"
+dynamic = ["version"]
+description = "Truss construction and analysis"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+  { name = "Christopher McComb", email = "ccmcc2012@gmail.com" },
+]
+keywords = ["truss", "structural analysis", "optimization", "engineering"]
+classifiers = [
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering",
+]
+dependencies = [
+  "matplotlib",
+  "numpy",
+  "pandas",
+  "scipy",
+  "tabulate",
+]
+
+[project.urls]
+Homepage = "https://github.com/cmccomb/TrussMe"
+Source = "https://github.com/cmccomb/TrussMe"
+Issues = "https://github.com/cmccomb/TrussMe/issues"
+
+[project.optional-dependencies]
+dev = [
+  "build>=1",
+  "pytest>=8",
+  "pytest-cov>=6",
+  "twine>=5",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "trussme._version.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["trussme*"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=trussme --cov-report=term-missing --cov-report=xml --cov-fail-under=85"
+markers = [
+  "slow: long-running optimization tests",
+]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["trussme"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = false

trussme-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

trussme-0.1.0/tests/example.trs

@@ -0,0 +1,50 @@
+# This file defines parameters for a truss. All columns are tab delimited.
+# Joints, members, and materials can be included in any order, and lines
+# beginning with a "#" symbol are ignored.
+
+# This block defines materials used in subsequent member definitions. The
+# order of hte columns is:
+# S name, density, elastic modulus, yield strength, source
+S   A36_Steel   7850.0   200_000_000_000.0   250_000_000.0   https://en.wikipedia.org/wiki/A36_steel
+
+# This block defines joints. The order of the columns is
+# J X-coord, Y-coord, Z-coord, X-support, Y-support, Z-support
+J   0.0   0.0   0.0   1   1   1
+J   1.0   0.0   0.0   0   0   1
+J   2.0   0.0   0.0   0   0   1
+J   3.0   0.0   0.0   0   0   1
+J   4.0   0.0   0.0   0   0   1
+J   5.0   0.0   0.0   1   1   1
+J   0.5   1.0   0.0   0   0   1
+J   1.5   1.0   0.0   0   0   1
+J   2.5   1.0   0.0   0   0   1
+J   3.5   1.0   0.0   0   0   1
+J   4.5   1.0   0.0   0   0   1
+
+# This block defines members. The order of the columns is
+# M joint1, joint2, material, shape, {parameters for shape, t=X, etc.}
+M   0   1   A36_Steel pipe    r=0.02    t=0.002
+M   1   2   A36_Steel pipe    r=0.02    t=0.002
+M   2   3   A36_Steel pipe    r=0.02    t=0.002
+M   3   4   A36_Steel pipe    r=0.02    t=0.002
+M   4   5   A36_Steel pipe    r=0.02    t=0.002
+M   6   7   A36_Steel pipe    r=0.02    t=0.002
+M   7   8   A36_Steel pipe    r=0.02    t=0.002
+M   8   9   A36_Steel pipe    r=0.02    t=0.002
+M   9   10  A36_Steel pipe    r=0.02    t=0.002
+M   0   6   A36_Steel pipe    r=0.02    t=0.002
+M   6   1   A36_Steel pipe    r=0.02    t=0.002
+M   1   7   A36_Steel pipe    r=0.02    t=0.002
+M   7   2   A36_Steel pipe    r=0.02    t=0.002
+M   2   8   A36_Steel pipe    r=0.02    t=0.002
+M   8   3   A36_Steel pipe    r=0.02    t=0.002
+M   3   9   A36_Steel pipe    r=0.02    t=0.002
+M   9   4   A36_Steel pipe    r=0.02    t=0.002
+M   4   10  A36_Steel pipe    r=0.02    t=0.002
+M   10  5   A36_Steel pipe    r=0.02    t=0.002
+
+# This block defines loads. The order of the columns is:
+# L joint, x-load, y-load, z-load
+L   7   0   -20000  0
+L   8   0   -20000  0
+L   9   0   -20000  0

trussme-0.1.0/tests/helpers.py

@@ -0,0 +1,87 @@
+from pathlib import Path
+
+import trussme
+
+
+TEST_TRUSS_FILENAME = Path(__file__).with_name("example.trs")
+
+
+def default_goals() -> trussme.Goals:
+    return trussme.Goals(
+        minimum_fos_buckling=1.5,
+        minimum_fos_yielding=1.5,
+        maximum_mass=5.0,
+        maximum_deflection=6e-3,
+    )
+
+
+def build_reference_truss() -> trussme.Truss:
+    truss = trussme.Truss()
+    truss.add_pinned_joint([0.0, 0.0, 0.0])
+    truss.add_free_joint([1.0, 0.0, 0.0])
+    truss.add_free_joint([2.0, 0.0, 0.0])
+    truss.add_free_joint([3.0, 0.0, 0.0])
+    truss.add_free_joint([4.0, 0.0, 0.0])
+    truss.add_pinned_joint([5.0, 0.0, 0.0])
+
+    truss.add_free_joint([0.5, 1.0, 0.0])
+    truss.add_free_joint([1.5, 1.0, 0.0])
+    truss.add_free_joint([2.5, 1.0, 0.0])
+    truss.add_free_joint([3.5, 1.0, 0.0])
+    truss.add_free_joint([4.5, 1.0, 0.0])
+
+    truss.add_out_of_plane_support("z")
+
+    truss.joints[7].loads[1] = -20000
+    truss.joints[8].loads[1] = -20000
+    truss.joints[9].loads[1] = -20000
+
+    for start, end in (
+        (0, 1),
+        (1, 2),
+        (2, 3),
+        (3, 4),
+        (4, 5),
+        (6, 7),
+        (7, 8),
+        (8, 9),
+        (9, 10),
+        (0, 6),
+        (6, 1),
+        (1, 7),
+        (7, 2),
+        (2, 8),
+        (8, 3),
+        (3, 9),
+        (9, 4),
+        (4, 10),
+        (10, 5),
+    ):
+        truss.add_member(start, end)
+
+    return truss
+
+
+def build_optimization_truss() -> trussme.Truss:
+    truss = build_reference_truss()
+    truss.joints[7].loads[1] = 0.0
+    truss.joints[9].loads[1] = 0.0
+    return truss
+
+
+def build_triangle_truss(shape=None) -> trussme.Truss:
+    truss = trussme.Truss()
+    pin = truss.add_pinned_joint([0.0, 0.0, 0.0])
+    free = truss.add_free_joint([2.5, 2.5, 0.0])
+    roller = truss.add_roller_joint([5.0, 0.0, 0.0])
+
+    truss.add_out_of_plane_support("z")
+    truss.set_load(free, [0.0, -10000.0, 0.0])
+
+    for start, end in ((pin, free), (pin, roller), (roller, free)):
+        if shape is None:
+            truss.add_member(start, end)
+        else:
+            truss.add_member(start, end, shape=shape())
+
+    return truss

trussme-0.1.0/tests/test_construction_and_io.py

@@ -0,0 +1,73 @@
+import doctest
+
+import pytest
+
+import trussme
+import trussme.components
+import trussme.report
+import trussme.truss
+
+from tests.helpers import TEST_TRUSS_FILENAME, build_reference_truss, default_goals
+
+
+@pytest.mark.parametrize(
+    "module",
+    [trussme, trussme.truss, trussme.components, trussme.report],
+)
+def test_doctests(module) -> None:
+    failed, _ = doctest.testmod(module, optionflags=doctest.ELLIPSIS)
+    assert failed == 0
+
+
+def test_build_methods() -> None:
+    goals = default_goals()
+    truss_from_commands = build_reference_truss()
+    truss_from_file = trussme.read_trs(str(TEST_TRUSS_FILENAME))
+
+    assert trussme.report_to_str(
+        truss_from_file,
+        goals,
+        with_figures=False,
+    ) == trussme.report_to_str(
+        truss_from_commands,
+        goals,
+        with_figures=False,
+    )
+
+
+def test_save_to_trs_and_rebuild(tmp_path) -> None:
+    goals = default_goals()
+    truss_from_file = trussme.read_trs(str(TEST_TRUSS_FILENAME))
+    output_path = tmp_path / "saved.trs"
+
+    truss_from_file.to_trs(str(output_path))
+    truss_rebuilt_from_file = trussme.read_trs(str(output_path))
+
+    assert trussme.report_to_str(
+        truss_from_file,
+        goals,
+        with_figures=False,
+    ) == trussme.report_to_str(
+        truss_rebuilt_from_file,
+        goals,
+        with_figures=False,
+    )
+
+
+def test_save_to_json_and_rebuild(tmp_path) -> None:
+    goals = default_goals()
+    truss_from_file = trussme.read_trs(str(TEST_TRUSS_FILENAME))
+    output_path = tmp_path / "saved.json"
+
+    truss_from_file.to_json(str(output_path))
+    truss_rebuilt_from_file = trussme.read_json(str(output_path))
+
+    assert trussme.report_to_str(
+        truss_from_file,
+        goals,
+        with_figures=False,
+    ) == trussme.report_to_str(
+        truss_rebuilt_from_file,
+        goals,
+        with_figures=False,
+    )

trussme-0.1.0/tests/test_custom_materials_and_shapes.py

@@ -0,0 +1,64 @@
+import unittest
+
+import trussme
+
+
+class TestCustomStuff(unittest.TestCase):
+    def test_custom_material(self):
+        # Build truss from scratch
+        truss = trussme.Truss()
+        truss.add_pinned_joint([0.0, 0.0, 0.0])
+        truss.add_free_joint([2.5, 2.5, 0.0])
+        truss.add_roller_joint([5.0, 0.0, 0.0])
+
+        truss.add_out_of_plane_support("z")
+
+        truss.joints[1].loads[1] = -20000
+
+        unobtanium: trussme.Material = {
+            "name": "unobtanium",
+            "yield_strength": 200_000_000_000,
+            "elastic_modulus": 200_000_000_000_000.0,
+            "density": 1_000.0,
+            "source": "https://en.wikipedia.org/wiki/Unobtainium",
+        }
+
+        truss.add_member(0, 1, material=unobtanium)
+        truss.add_member(1, 2, material=unobtanium)
+        truss.add_member(2, 0, material=unobtanium)
+
+        truss.analyze()
+
+        self.assertIsNotNone(truss.fos)
+
+    def test_custom_shape(self):
+        # Build truss from scratch
+        truss = trussme.Truss()
+        truss.add_pinned_joint([0.0, 0.0, 0.0])
+        truss.add_free_joint([2.5, 2.5, 0.0])
+        truss.add_roller_joint([5.0, 0.0, 0.0])
+
+        truss.add_out_of_plane_support("z")
+
+        truss.joints[1].loads[1] = -20000
+
+        class MagicalRod(trussme.Shape):
+            def __init__(self):
+                self._params = {}
+
+            def moi(self) -> float:
+                return 200_000_000_000
+
+            def area(self) -> float:
+                return 100_000
+
+            def name(self) -> str:
+                return "magical rod"
+
+        truss.add_member(0, 1, shape=MagicalRod())
+        truss.add_member(1, 2, shape=MagicalRod())
+        truss.add_member(2, 0, shape=MagicalRod())
+
+        truss.analyze()
+
+        self.assertIsNotNone(truss.fos)

trussme-0.1.0/tests/test_material_sources.py

@@ -0,0 +1,43 @@
+"""Tests for built-in material sources.
+
+These tests ensure every material in ``MATERIAL_LIBRARY`` specifies a
+source URL so that property data can be traced back to its origin.
+"""
+
+from __future__ import annotations
+
+from urllib.parse import urlparse
+
+from trussme.components import MATERIAL_LIBRARY
+
+
+def test_every_material_has_source() -> None:
+    """Each material should define a non-empty ``source`` URL."""
+
+    # Act
+    sources = [material.get("source", "") for material in MATERIAL_LIBRARY]
+
+    # Assert
+    for source in sources:
+        parsed = urlparse(source)
+        assert parsed.scheme in {"http", "https"}
+        assert parsed.netloc
+
+
+def test_common_materials_present() -> None:
+    """Selected materials should ship with the library."""
+
+    # Arrange
+    expected = {
+        "A36_Steel",
+        "A992_Steel",
+        "6061_T6_Aluminum",
+        "7075_T6_Aluminum",
+        "304_Stainless_Steel",
+    }
+
+    # Act
+    names = {material["name"] for material in MATERIAL_LIBRARY}
+
+    # Assert
+    assert expected.issubset(names)

trussme-0.1.0/tests/test_member_index.py

@@ -0,0 +1,41 @@
+"""Tests for member addition functions."""
+
+import trussme
+import pytest
+
+
+def test_add_member_returns_index() -> None:
+    """Ensure ``add_member`` returns the new member index."""
+    # Arrange
+    truss = trussme.Truss()
+    start = truss.add_free_joint([0.0, 0.0, 0.0])
+    end = truss.add_free_joint([1.0, 0.0, 0.0])
+
+    # Act
+    idx = truss.add_member(start, end)
+
+    # Assert
+    assert idx == 0
+
+
+def test_add_member_invalid_index() -> None:
+    """``add_member`` should raise when given an invalid joint index."""
+    # Arrange
+    truss = trussme.Truss()
+    valid = truss.add_free_joint([0.0, 0.0, 0.0])
+    _ = truss.add_free_joint([1.0, 0.0, 0.0])
+
+    # Act / Assert
+    with pytest.raises(IndexError):
+        truss.add_member(5, valid)
+
+
+def test_add_member_identical_indices() -> None:
+    """``add_member`` rejects using the same joint for both ends."""
+    # Arrange
+    truss = trussme.Truss()
+    joint = truss.add_free_joint([0.0, 0.0, 0.0])
+
+    # Act / Assert
+    with pytest.raises(ValueError):
+        truss.add_member(joint, joint)