mechlab 0.0.1__tar.gz

mechlab-0.0.1/LICENSE

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

mechlab-0.0.1/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: mechlab
+Version: 0.0.1
+Summary: Computational Mechanical Engineering Toolkit
+License: MIT
+License-File: LICENSE
+Keywords: mechanical-engineering,thermodynamics,fluid-mechanics,control-systems,engineering,scientific-computing
+Author: Sewak Sunar
+Author-email: sewaksunar@hotmail.com
+Requires-Python: >=3.14
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Dist: colorama (==0.4.6)
+Requires-Dist: contourpy (==1.3.3)
+Requires-Dist: control (==0.10.2)
+Requires-Dist: coolprop (==7.2.0)
+Requires-Dist: cycler (==0.12.1)
+Requires-Dist: flexcache (==0.3)
+Requires-Dist: flexparser (==0.4)
+Requires-Dist: fluids (==1.3.0)
+Requires-Dist: fonttools (==4.61.1)
+Requires-Dist: furo (>=2025.12.19,<2026.0.0)
+Requires-Dist: iniconfig (==2.3.0)
+Requires-Dist: kiwisolver (==1.4.9)
+Requires-Dist: matplotlib (==3.10.8)
+Requires-Dist: mpmath (==1.3.0)
+Requires-Dist: myst-parser (>=5.0.0,<6.0.0)
+Requires-Dist: numpy (==2.4.1)
+Requires-Dist: packaging (==26.0)
+Requires-Dist: pillow (==12.1.0)
+Requires-Dist: pint (==0.25.2)
+Requires-Dist: platformdirs (==4.5.1)
+Requires-Dist: pluggy (==1.6.0)
+Requires-Dist: pygments (==2.19.2)
+Requires-Dist: pyparsing (==3.3.2)
+Requires-Dist: pytest (==9.0.2)
+Requires-Dist: python-dateutil (==2.9.0.post0)
+Requires-Dist: scipy (==1.17.0)
+Requires-Dist: six (==1.17.0)
+Requires-Dist: sphinx-autobuild (>=2025.8.25,<2026.0.0)
+Requires-Dist: sphinx-copybutton (>=0.5.2,<0.6.0)
+Requires-Dist: sphinx-design (>=0.7.0,<0.8.0)
+Requires-Dist: sympy (==1.14.0)
+Requires-Dist: typing-extensions (==4.15.0)
+Description-Content-Type: text/markdown
+
+![PyPI](https://img.shields.io/pypi/v/mechlab)
+![License](https://img.shields.io/pypi/l/mechlab)
+![Python](https://img.shields.io/pypi/pyversions/mechlab)
+# MechLab 🔧📘
+
+**MechLab** is an open‑source Python library for **mechanical engineering computations**, designed to provide a unified, modular, and extensible toolkit for students, researchers, and practicing engineers.
+
+It brings together commonly used scientific libraries under a clean, engineering‑focused API for **thermodynamics, fluid mechanics, control systems, and numerical analysis**.
+
+---
+
+## ✨ Features
+
+* 🔥 Thermodynamics utilities (properties, processes, cycles)
+* 🌊 Fluid mechanics calculations (dimensionless numbers, flow relations)
+* 🎛️ Control systems support
+* 🧮 Symbolic & numerical computation
+* 📐 Unit‑safe calculations (planned)
+* 🧱 Modular structure (easy to extend)
+
+---
+
+## 📦 Installation
+
+Install directly from **PyPI**:
+
+```bash
+pip install mechlab
+```
+
+Or using **Poetry**:
+
+```bash
+poetry add mechlab
+```
+
+---
+
+## 🚀 Quick Start
+
+```python
+from mechlab.thermodynamics import enthalpy_TP
+
+h = enthalpy_TP(
+    fluid="Water",
+    T=500,        # Temperature in K
+    P=3e6         # Pressure in Pa
+)
+
+print(f"Enthalpy: {h:.2f} J/kg")
+```
+
+---
+
+## 📂 Package Structure
+
+```text
+mechlab/
+│
+├── thermodynamics/
+│   ├── __init__.py
+│   ├── properties.py
+│   └── cycles.py
+│
+├── fluid_mechanics/
+│   ├── __init__.py
+│   └── dimensionless.py
+│
+├── control_systems/
+│   ├── __init__.py
+│   └── linear.py
+│
+├── utils/
+│   ├── __init__.py
+│   └── constants.py
+│
+└── __init__.py
+```
+
+---
+
+## 🔬 Dependencies
+
+MechLab is built on top of proven scientific libraries:
+
+* `numpy`
+* `scipy`
+* `sympy`
+* `control`
+* `fluids`
+* `CoolProp`
+* `pint`
+* `matplotlib`
+
+These are installed automatically with MechLab.
+
+---
+
+## 🧠 Design Philosophy
+
+* **Engineering‑first API** (clear variable names, physical meaning)
+* **Readable code** over premature optimization
+* **Modular** – each subject area is independent
+* **Extensible** – easy to add new models & correlations
+
+---
+
+## 📈 Roadmap
+
+* [ ] Rankine, Otto, Diesel cycles
+* [ ] Pipe flow & heat exchanger modules
+* [ ] Full unit‑aware API using Pint
+* [ ] Validation against textbook examples
+* [ ] Interactive Jupyter examples
+* [ ] Documentation website
+
+---
+
+## 🧪 Development Setup
+
+Clone the repository:
+
+```bash
+git clone https://github.com/sewaksunar/mechlab.git
+cd mechlab
+```
+
+Install dependencies with Poetry:
+
+```bash
+poetry install
+poetry shell
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Open a Pull Request
+
+Please follow:
+
+* PEP‑8 style
+* Clear docstrings
+* Basic tests for new features
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**.
+
+---
+
+## 👤 Author
+
+**Sewak Sunar**
+Mechanical Engineering Enthusiast & Python Developer
+
+* GitHub: [https://github.com/sewaksunar](https://github.com/sewaksunar)
+
+---
+
+## ⭐ Acknowledgements
+
+Inspired by mechanical engineering textbooks and the open‑source scientific Python ecosystem.
+
+If you find MechLab useful, please ⭐ the repository on GitHub!
+

mechlab-0.0.1/README.md

@@ -0,0 +1,179 @@
+![PyPI](https://img.shields.io/pypi/v/mechlab)
+![License](https://img.shields.io/pypi/l/mechlab)
+![Python](https://img.shields.io/pypi/pyversions/mechlab)
+# MechLab 🔧📘
+
+**MechLab** is an open‑source Python library for **mechanical engineering computations**, designed to provide a unified, modular, and extensible toolkit for students, researchers, and practicing engineers.
+
+It brings together commonly used scientific libraries under a clean, engineering‑focused API for **thermodynamics, fluid mechanics, control systems, and numerical analysis**.
+
+---
+
+## ✨ Features
+
+* 🔥 Thermodynamics utilities (properties, processes, cycles)
+* 🌊 Fluid mechanics calculations (dimensionless numbers, flow relations)
+* 🎛️ Control systems support
+* 🧮 Symbolic & numerical computation
+* 📐 Unit‑safe calculations (planned)
+* 🧱 Modular structure (easy to extend)
+
+---
+
+## 📦 Installation
+
+Install directly from **PyPI**:
+
+```bash
+pip install mechlab
+```
+
+Or using **Poetry**:
+
+```bash
+poetry add mechlab
+```
+
+---
+
+## 🚀 Quick Start
+
+```python
+from mechlab.thermodynamics import enthalpy_TP
+
+h = enthalpy_TP(
+    fluid="Water",
+    T=500,        # Temperature in K
+    P=3e6         # Pressure in Pa
+)
+
+print(f"Enthalpy: {h:.2f} J/kg")
+```
+
+---
+
+## 📂 Package Structure
+
+```text
+mechlab/
+│
+├── thermodynamics/
+│   ├── __init__.py
+│   ├── properties.py
+│   └── cycles.py
+│
+├── fluid_mechanics/
+│   ├── __init__.py
+│   └── dimensionless.py
+│
+├── control_systems/
+│   ├── __init__.py
+│   └── linear.py
+│
+├── utils/
+│   ├── __init__.py
+│   └── constants.py
+│
+└── __init__.py
+```
+
+---
+
+## 🔬 Dependencies
+
+MechLab is built on top of proven scientific libraries:
+
+* `numpy`
+* `scipy`
+* `sympy`
+* `control`
+* `fluids`
+* `CoolProp`
+* `pint`
+* `matplotlib`
+
+These are installed automatically with MechLab.
+
+---
+
+## 🧠 Design Philosophy
+
+* **Engineering‑first API** (clear variable names, physical meaning)
+* **Readable code** over premature optimization
+* **Modular** – each subject area is independent
+* **Extensible** – easy to add new models & correlations
+
+---
+
+## 📈 Roadmap
+
+* [ ] Rankine, Otto, Diesel cycles
+* [ ] Pipe flow & heat exchanger modules
+* [ ] Full unit‑aware API using Pint
+* [ ] Validation against textbook examples
+* [ ] Interactive Jupyter examples
+* [ ] Documentation website
+
+---
+
+## 🧪 Development Setup
+
+Clone the repository:
+
+```bash
+git clone https://github.com/sewaksunar/mechlab.git
+cd mechlab
+```
+
+Install dependencies with Poetry:
+
+```bash
+poetry install
+poetry shell
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Open a Pull Request
+
+Please follow:
+
+* PEP‑8 style
+* Clear docstrings
+* Basic tests for new features
+
+---
+
+## 📜 License
+
+This project is licensed under the **MIT License**.
+
+---
+
+## 👤 Author
+
+**Sewak Sunar**
+Mechanical Engineering Enthusiast & Python Developer
+
+* GitHub: [https://github.com/sewaksunar](https://github.com/sewaksunar)
+
+---
+
+## ⭐ Acknowledgements
+
+Inspired by mechanical engineering textbooks and the open‑source scientific Python ecosystem.
+
+If you find MechLab useful, please ⭐ the repository on GitHub!

mechlab-0.0.1/mechlab/mechanics/__init__.py

@@ -0,0 +1,2 @@
+from .statics import Beam, RigidBody
+__all__ = ["Beam"]

mechlab-0.0.1/mechlab/mechanics/statics.py

@@ -0,0 +1,56 @@
+r"""
+Mechanics & Dynamics
+====================
+
+This module provides tools for both static structural analysis and 
+rigid body dynamics.
+"""
+
+class Beam:
+    r"""
+    Represents a structural cantilever beam.
+
+    **Deflection Formula:**
+
+    .. math::
+
+        \delta_{max} = \frac{P L^3}{3 E I}
+
+    Args:
+        L (float): Length [m].
+        E (float): Young's Modulus [Pa].
+        I (float): Moment of Inertia [m^4].
+    """
+    def __init__(self, L, E, I):
+        self.L, self.E, self.I = L, E, I
+
+    def max_deflection(self, load):
+        r"""
+        Calculates max deflection at the free end using:
+        :math:`\delta = \frac{FL^3}{3EI}`
+        """
+        return (load * self.L**3) / (3 * self.E * self.I)
+
+
+
+class RigidBody:
+    r"""
+    Represents a point mass for dynamic calculations.
+
+    **Weight Calculation:**
+
+    .. math::
+
+        W = m \cdot g
+
+    Args:
+        mass (float): Mass [kg].
+        position (tuple): (x, y) coordinates [m].
+    """
+    def __init__(self, mass, position):
+        self.mass = mass
+        self.position = position
+
+    def weight(self):
+        """Returns weight in Newtons (:math:`N`)."""
+        return self.mass * 9.81

mechlab-0.0.1/mechlab/thermodynamics/__init__.py

@@ -0,0 +1,12 @@
+"""
+Thermodynamics Module
+=====================
+"""
+# Only import what definitely exists
+from .state import State
+
+# If properties.py doesn't have get_fluid_properties yet, 
+# comment this out until the function is written:
+# from .properties import get_fluid_properties 
+
+__all__ = ["State"]

mechlab-0.0.1/mechlab/thermodynamics/properties.py

@@ -0,0 +1,18 @@
+import numpy as np
+import sympy as sp
+
+# Symbols for SymPy
+P, V, n, R, T = sp.symbols('P V n R T')
+
+def enthalpy_TP(fluid: str, temp: float, press: float) -> float:
+    # Example: Simple CP*T for an ideal gas
+    cp_air = 1005 # J/kg-K
+    return cp_air * temp
+
+def entropy_TP(fluid: str, temp: float, press: float) -> float:
+    # Example: Simple calculation
+    return 1.0 * temp / press 
+
+def get_pressure_func():
+    ideal_gas_eq = (n * R * T) / V
+    return sp.lambdify((n, R, T, V), ideal_gas_eq, 'numpy')

mechlab-0.0.1/mechlab/thermodynamics/state.py

@@ -0,0 +1,17 @@
+class State:
+    """
+    Represents a thermodynamic state of a pure substance.
+
+    Usage:
+        >>> from mechlab.thermodynamics import State
+        >>> water = State("water", T=373.15, P=101325)
+        >>> print(f"Enthalpy: {water.h:.2f} J/kg")
+
+    Expected Output:
+        .. code-block:: text
+
+           Enthalpy: 2675529.15 J/kg
+
+    The state is defined by two independent intensive properties. 
+    Internal logic handles phase detection (Subcooled, Saturated, Superheated).
+    """

mechlab-0.0.1/mechlab/thermodynamics/test_run.py

@@ -0,0 +1,23 @@
+from mechlab.thermodynamics import state
+import numpy as np
+
+def run_test():
+    print("--- Starting Thermodynamics Test (SymPy/NumPy) ---")
+    
+    # 1. Test the Enthalpy function (Linear model)
+    temp = 300.0
+    press = 101325.0
+    h = state.enthalpy_TP("Air", temp, press)
+    print(f"Calculated Enthalpy: {h} J/kg")
+
+    # 2. Test the Symbolic-to-Numerical Pressure function
+    p_func = state.get_pressure_func()
+    # P = nRT/V -> (1 mole, 8.314 R, 300K, 0.025 m^3)
+    p_result = p_func(1.0, 8.314, 300, 0.025)
+    print(f"Calculated Pressure: {p_result:,.2f} Pa")
+    
+    print("------------------------------------------------")
+    print("SUCCESS: All functions executed correctly!")
+
+if __name__ == "__main__":
+    run_test()

mechlab-0.0.1/pyproject.toml

@@ -0,0 +1,88 @@
+[project]
+name = "mechlab"
+version = "0.0.1"
+description = "Computational Mechanical Engineering Toolkit"
+readme = "README.md"  # Crucial: This links your description to PyPI
+requires-python = ">=3.14"
+authors = [
+    {name = "Sewak Sunar", email = "sewaksunar@hotmail.com"}
+]
+license = {text = "MIT"}
+
+keywords = [
+  "mechanical-engineering",
+  "thermodynamics",
+  "fluid-mechanics",
+  "control-systems",
+  "engineering",
+  "scientific-computing"
+]
+
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Education",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Scientific/Engineering :: Physics",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent"
+]
+
+dependencies = [
+    "colorama (==0.4.6)",
+    "contourpy (==1.3.3)",
+    "control (==0.10.2)",
+    "coolprop (==7.2.0)",
+    "cycler (==0.12.1)",
+    "flexcache (==0.3)",
+    "flexparser (==0.4)",
+    "fluids (==1.3.0)",
+    "fonttools (==4.61.1)",
+    "iniconfig (==2.3.0)",
+    "kiwisolver (==1.4.9)",
+    "matplotlib (==3.10.8)",
+    "mpmath (==1.3.0)",
+    "numpy (==2.4.1)",
+    "packaging (==26.0)",
+    "pillow (==12.1.0)",
+    "pint (==0.25.2)",
+    "platformdirs (==4.5.1)",
+    "pluggy (==1.6.0)",
+    "pygments (==2.19.2)",
+    "pyparsing (==3.3.2)",
+    "pytest (==9.0.2)",
+    "python-dateutil (==2.9.0.post0)",
+    "scipy (==1.17.0)",
+    "six (==1.17.0)",
+    "sympy (==1.14.0)",
+    "typing-extensions (==4.15.0)",
+    "furo (>=2025.12.19,<2026.0.0)",
+    "sphinx-copybutton (>=0.5.2,<0.6.0)",
+    "myst-parser (>=5.0.0,<6.0.0)",
+    "sphinx-design (>=0.7.0,<0.8.0)",
+    "sphinx-autobuild (>=2025.8.25,<2026.0.0)"
+]
+
+[tool.poetry]
+# Keep the package inclusion here
+packages = [
+  { include = "mechlab" }
+]
+
+[dependency-groups]
+docs = [
+    "sphinx (>=9.1.0,<10.0.0)",
+    "sphinx-autodoc-typehints (>=3.6.2,<4.0.0)",
+    "furo (>=2025.12.19,<2026.0.0)",
+    "myst-parser (>=5.0.0,<6.0.0)",
+    "sphinx-design (>=0.7.0,<0.8.0)",
+    "sphinx-copybutton (>=0.5.2,<0.6.0)"
+]
+
+[project.scripts]
+dev = "scripts:docs_dev"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"