aiken-engineering 0.1.0__py3-none-any.whl

aiken_engineering-0.1.0.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: aiken-engineering
+Version: 0.1.0
+Summary: Engineering utilities.
+Author: Eric Rudolph
+License-Expression: MIT
+Keywords: engineering,plotting,matplotlib,fatigue,impact
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.11.0
+Provides-Extra: test
+Requires-Dist: pytest>=9.1.0; extra == "test"
+Dynamic: license-file
+
+Copyright (c) 2026 Aiken Engineering
+
+MIT License

aiken_engineering-0.1.0.dist-info/RECORD

@@ -0,0 +1,35 @@
+aiken_engineering-0.1.0.dist-info/licenses/LICENSE,sha256=e3aBwfyFwaSl_-9mcOdffgvD1bvGAVtWg8dUwQvNFIc,1074
+engineering_tools/__init__.py,sha256=srcpmef_gY90z77kYxYxmAkkvArxq3XpIgxr0hgnfYI,642
+engineering_tools/ansys_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/ansys_tools/ansys_file_ops.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/ansys_tools/read_elements.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/ansys_tools/read_nodes.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/ansys_tools/read_pretab.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/ansys_tools/read_prnsol.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/bolts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/fatigue/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/fatigue/asme_fatigue_curves.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/fatigue/dnv_fatigue_curves.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/concrete_impact.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/fea_impact.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/impact_helpers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/metals_impact.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/impact/poly_carbonate_impact.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/materials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/materials/true_stress_true_strain.py,sha256=OZYVLSHiSqs6cuRbdoZ7liRtDIpo4OmGWPkV74_jOZc,30
+engineering_tools/plotting/__init__.py,sha256=E9waV0FS45M33ZIiErVcy2ngLbpojCEAZIOyiCHdNAI,1369
+engineering_tools/plotting/colors.py,sha256=FMAKC8LPnS0wsv4hubvOvFWLcj2QFmTFaxeM4MWtjtc,3656
+engineering_tools/plotting/fatigue_plots.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/plotting/impact_plots.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/plotting/plotting_helpers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/plotting/stress_strain_plots.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/plotting/styles.py,sha256=LYdHnO_Mpu-3Ut21Uz6Kl-AiSIsEt5v8hWL-BeR1opY,4158
+engineering_tools/tanks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/units/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+engineering_tools/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aiken_engineering-0.1.0.dist-info/METADATA,sha256=_fAJ5w58_ovCGVVkHWpVh54dHzA3IaDIROwHjSVCnpk,763
+aiken_engineering-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+aiken_engineering-0.1.0.dist-info/top_level.txt,sha256=PYhQm6KOvdKCZoKW3569-wzmmglR1XOoowqhNra28zs,18
+aiken_engineering-0.1.0.dist-info/RECORD,,

aiken_engineering-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aiken_engineering-0.1.0.dist-info/licenses/LICENSE

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

aiken_engineering-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+engineering_tools

engineering_tools/__init__.py

@@ -0,0 +1,31 @@
+"""
+Top-level public API for engineering_tools.
+"""
+
+# TODO: Figure out what I really want in the top level API...
+
+from engineering_tools.plotting import (
+    ENGINEERING_STYLE,
+    PRESENTATION_STYLE,
+    REPORT_STYLE,
+    engineering_style,
+    presentation_style,
+    report_style,
+    reset_style,
+    use_engineering_style,
+    use_presentation_style,
+    use_report_style,
+)
+
+__all__ = [
+    "ENGINEERING_STYLE",
+    "PRESENTATION_STYLE",
+    "REPORT_STYLE",
+    "engineering_style",
+    "presentation_style",
+    "report_style",
+    "reset_style",
+    "use_engineering_style",
+    "use_presentation_style",
+    "use_report_style",
+]

engineering_tools/materials/true_stress_true_strain.py

@@ -0,0 +1 @@
+# TODO true stress true strain

engineering_tools/plotting/__init__.py

@@ -0,0 +1,63 @@
+# Copyright (c) 2026 Aiken Engineering
+# SPDX-License-Identifier: MIT
+
+"""
+Plotting utilities for engineering_tools.
+
+This subpackage provides:
+- Matplotlib style configuration
+- Engineering-focused plotting helpers
+- Domain-specific plotting functions
+"""
+
+from engineering_tools.plotting.styles import (
+    ENGINEERING_STYLE,
+    PRESENTATION_STYLE,
+    REPORT_STYLE,
+    engineering_style,
+    presentation_style,
+    report_style,
+    reset_style,
+    use_engineering_style,
+    use_presentation_style,
+    use_report_style,
+)
+
+from engineering_tools.plotting.colors import (
+    RGB255,
+    RGB01,
+    ANSYS_COLORS,
+    ANSYS_LISTED_CMAP,
+    ANSYS_LINEAR_CMAP,
+    validate_rgb255,
+    rgb255_to_rgb01,
+    rgb255_sequence_to_rgb01,
+    make_listed_colormap,
+    make_linear_colormap,
+)
+
+__all__ = [
+    # Styles
+    "ENGINEERING_STYLE",
+    "PRESENTATION_STYLE",
+    "REPORT_STYLE",
+    "engineering_style",
+    "presentation_style",
+    "report_style",
+    "reset_style",
+    "use_engineering_style",
+    "use_presentation_style",
+    "use_report_style",
+
+    # Colors
+    "RGB255",
+    "RGB01",
+    "ANSYS_COLORS",
+    "ANSYS_LISTED_CMAP",
+    "ANSYS_LINEAR_CMAP",
+    "validate_rgb255",
+    "rgb255_to_rgb01",
+    "rgb255_sequence_to_rgb01",
+    "make_listed_colormap",
+    "make_linear_colormap",
+]

engineering_tools/plotting/colors.py

@@ -0,0 +1,126 @@
+"""
+Custom color palettes and colormaps for engineering plots.
+
+
+Color sequences are stored as 8-bit RGB tuples by default:
+
+    (R, G, B)
+
+where each channel is in the range 0 to 255.
+
+Helper functions are provided to convert these colors into Matplotlib-friendly
+formats.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TypeAlias
+
+from matplotlib.colors import LinearSegmentedColormap, ListedColormap
+
+RGB255: TypeAlias = tuple[int, int, int]
+RGB01: TypeAlias = tuple[float, float, float]
+
+ANSYS_COLORS: list[RGB255] = [
+    (0, 0, 255),
+    (0, 160, 255),
+    (0, 255, 255),
+    (0, 255, 255),
+    (0, 255, 0),
+    (178, 255, 0),
+    (255, 255, 0),
+    (255, 145, 0),
+    (255, 0, 0),
+]
+
+
+def validate_rgb255(colors: Sequence[RGB255]) -> None:
+    """
+    Validate a sequence of 8-bit RGB colors.
+
+    Parameters
+    ----------
+    colors : Sequence[RGB255]
+        Sequence of 8-bit RGB colors - tuples should containe three integers
+        in the range 0 to 255.
+
+    Raises
+    ------
+    ValueError
+        If any color in the sequence is not a valid 8-bit RGB color.
+    """
+
+    for color in colors:
+        if len(color) != 3:
+            raise ValueError(f"Expected RGB tuple with 3 channels, got {color!r}.")
+
+        for channel in color:
+            if not isinstance(channel, int):
+                raise ValueError(f"Expected integer channel in range 0 to 255, got {channel!r}.")
+
+            if not 0 <= channel <= 255:
+                raise ValueError(f"Expected integer channel in range 0 to 255, got {channel!r}.")
+
+
+def rgb255_to_rgb01(color: RGB255) -> RGB01:
+    """
+    Convert a single RGB color from 0-255 range to 0-1 range.
+
+    Matplotlib generally expects RGB colors in the range 0 to 1.
+
+    Examples
+    --------
+    >>> rgb255_to_rgb01((255, 128, 0))
+    (1.0, 0.5019607843137255, 0.0)
+    """
+    validate_rgb255([color])
+    return tuple(channel / 255 for channel in color)
+
+
+def rgb255_sequence_to_rgb01(colors: Sequence[RGB255]) -> list[RGB01]:
+    """
+    Convert a sequence of 8-bit RGB colors to Matplotlib 0-1 colors.
+    """
+    validate_rgb255(colors)
+    return [rgb255_to_rgb01(color) for color in colors]
+
+
+def make_listed_colormap(colors: Sequence[RGB255],
+                         *,
+                         name: str = "custom_colormap"
+                         ) -> ListedColormap:
+    """
+    Create a Matplotlib ListedColormap from 8-bit RGB colors.
+
+    A ListedColromap is useful when you want discrete color bands.
+
+    Examples
+    ________
+    >>> cmap = make_listed_colormap(ANSYS_COLORS, name="ansys")
+    """
+    rgb01_colors = rgb255_sequence_to_rgb01(colors)
+    return ListedColormap(rgb01_colors, name=name)
+
+
+def make_linear_colormap(colors: Sequence[RGB255],
+                         *,
+                         name: str = "custom_linear_colormap",
+                         n_colors: int = 256,
+                         ) -> LinearSegmentedColormap:
+    """
+    Create a smooth Matplotlib LinearSegmentedColormap from 8-bit RGB colors.
+
+    A LinearSegmentedColormap is useful when you want smooth interpolation
+    between colors.
+
+    Examples
+    --------
+    >>> cmap = make_linear_colormap(ANSYS_COLORS, name="ansys_smooth")
+    """
+    rgb01_colors = rgb255_sequence_to_rgb01(colors)
+    return LinearSegmentedColormap.from_list(name, rgb01_colors, N=n_colors)
+
+
+ANSYS_LISTED_CMAP = make_listed_colormap(ANSYS_COLORS, name="ansys")
+ANSYS_LINEAR_CMAP = make_linear_colormap(ANSYS_COLORS, name="ansys_smooth")

engineering_tools/plotting/styles.py

@@ -0,0 +1,181 @@
+"""
+matplotlib style utilities for engineering plots.
+
+This module defines rcParams dictionaries and helper functions for
+applying styles temporarily or globally.
+
+The main function is:
+
+    use_engineering_style()
+
+For temporary styling, use:
+
+    with engineering_style():
+        ...
+
+"""
+
+from __future__ import annotations
+
+from contextlib import contextmanager
+from typing import Iterator
+
+import matplotlib as mpl
+import matplotlib.pyplot as plt
+from matplotlib.pyplot import savefig
+
+ENGINEERING_STYLE: dict[str, object] = {
+    # Figure
+    "figure.figsize": (8, 5),
+    "figure.dpi": 120,
+    "savefig.dpi": 300,
+    "savefig.bbox": "tight",
+
+    # Axes
+    "axes.titlesize": 12,
+    "axes.labelsize": 10,
+    "axes.grid": True,
+    "axes.formatter.use_mathtext": True,
+
+    # ticks
+    "xtick.top": True,
+    "xtick.labelsize": 8,
+    "xtick.direction": "in",
+    "xtick.minor.visible": True,
+    "ytick.right": True,
+    "ytick.labelsize": 8,
+    "ytick.direction": "in",
+    "ytick.minor.visible": True,
+
+    # Grid
+    "grid.linewidth": 0.5,
+    "grid.alpha": 0.35,
+
+    # legend
+    "legend.frameon": True,
+    "legend.fontsize": "small",
+    "legend.framealpha": 1.0,
+
+    # Lines
+    "lines.linewidth": 2.0,
+}
+
+REPORT_STYLE: dict[str, object] = {
+    **ENGINEERING_STYLE,
+
+    # Better for reports and saved figures
+    "figure.figsize": (6.5, 4.5),
+    "figure.dpi": 120,
+    "savefig.dpi": 300,
+
+    # Change text style
+    # TODO: Finish developing the REPORT_STYLE
+}
+
+PRESENTATION_STYLE: dict[str, object] = {
+    **ENGINEERING_STYLE,
+
+    # Better for slides and large displays
+    # TODO: Finish developing the PRESENTATION_STYLE
+
+    # Larger Text
+
+    # Heavier Lines
+
+}
+
+
+def use_engineering_style() -> None:
+    """
+    Apply the default engineering style globally.
+
+    This modifies Matplotlib's rcParams for the current Python session.
+
+    Examples
+    --------
+    >>> from engineering_tools import use_engineering_style
+    >>> use_engineering_style()
+    """
+
+    mpl.rcParams.update(ENGINEERING_STYLE)
+
+
+def use_report_style() -> None:
+    """
+    Apply the report style globally.  This style is useful for figures
+    intended for documents and reports.
+
+    This modifies Matplotlib's rcParams for the current Python session.
+
+    Examples
+    --------
+    >>> from engineering_tools import use_report_style
+    >>> use_report_style()
+    """
+
+    mpl.rcParams.update(REPORT_STYLE)
+
+
+def use_presentation_style() -> None:
+    """
+    Apply the presentation style globally.  This style us useful for figures
+    intended for slides and screen sharing.
+
+    This modifies Matplotlib's rcParams for the current Python session.
+
+    Examples
+    --------
+    >>> from engineering_tools import use_presentation_style
+    >>> use_presentation_style()
+    """
+
+    mpl.rcParams.update(PRESENTATION_STYLE)
+
+
+def reset_style() -> None:
+    """
+    Reset the Matplotlib style settings to Matplotlib defaults.
+    """
+    plt.rcdefaults()
+
+
+@contextmanager
+def engineering_style() -> Iterator[None]:
+    """
+    Temporarily apply the default engineering style.
+
+    This does not permanently modify Matplotlib's global style outside
+    the context manager.
+
+    Examples
+    --------
+    >>> import matplotlib.pyplot as plt
+    >>> from engineering_tools import engineering_style
+    >>>
+    >>> with engineering_style():
+    ...     fig, ax = plt.subplots()
+    ...     ax.plot([0, 1, 2], [0, 1, 4])
+    ...     ax.set_xlabel("Time [s]")
+    ...     ax.set_ylabel("Displacement [mm]")
+    ...     plt.show()
+    """
+    with mpl.rc_context(rc=ENGINEERING_STYLE):
+        yield
+
+
+@contextmanager
+def report_style() -> Iterator[None]:
+    """
+    Temporarily apply the report plotting style.
+    """
+    with mpl.rc_context(rc=REPORT_STYLE):
+        yield
+
+
+@contextmanager
+def presentation_style() -> Iterator[None]:
+    """
+    Temporarily apply the presentation plotting style.
+    """
+    with mpl.rc_context(rc=PRESENTATION_STYLE):
+        yield