mechlab 0.2.2__tar.gz → 0.2.4__tar.gz

mechlab-0.2.4/.gitignore

@@ -0,0 +1,17 @@
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.poetry/
+
+
+mechlab-docs/
+
+# Python Build Folder
+dist/
+
+# Virtual Environments
+.venv/

mechlab-0.2.4/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "liveServer.settings.port": 5501
+}

mechlab-0.2.4/DEVLOG.md

@@ -0,0 +1,373 @@
+Perfect 👍
+Below is a **complete, clean, copy-paste ready `DEVLOG.md`** written in **proper Markdown**, covering **everything step-by-step**: setup, docs, GitHub Pages, and PyPI publishing.
+
+You can save this **exactly as `DEVLOG.md`** in your repo root.
+
+---
+
+# MechLab – Development & Deployment Log (DEVLOG)
+
+This document records the **complete setup, documentation, GitHub Pages deployment, and PyPI publishing workflow** for the `mechlab` Python library.
+
+It is intended to be reusable for **future releases**.
+
+---
+
+## Project Information
+
+- **Package name:** mechlab
+- **Current version:** 0.1.1
+- **Description:** Computational Mechanical Engineering Toolkit
+- **Author:** Sewak Sunar
+- **License:** MIT
+- **Build system:** Poetry (PEP 621)
+- **Documentation:** Sphinx
+- **Hosting:** GitHub Pages
+- **Distribution:** PyPI
+
+---
+
+## 1. Environment Setup
+
+### Python
+- Python **>= 3.14**
+
+### Poetry
+Install Poetry:
+```bash
+pip install poetry
+````
+
+Enable in-project virtual environment:
+
+```bash
+poetry config virtualenvs.in-project true
+```
+
+Install dependencies:
+
+```bash
+poetry install
+```
+
+Activate environment (Poetry 2.x):
+
+```bash
+poetry env activate
+```
+
+> Note: `poetry shell` is deprecated in Poetry ≥ 2.0
+
+---
+
+## 2. Project Structure
+
+```text
+mechlab/
+├── mechlab/              # Python package
+├── docs/                 # Sphinx documentation
+│   ├── source/
+│   └── build/
+├── pyproject.toml
+├── poetry.lock
+├── README.md
+├── LICENSE
+└── DEVLOG.md
+```
+
+---
+
+## 3. Documentation (Sphinx)
+
+### Install documentation dependencies
+
+```bash
+poetry add --group docs sphinx furo myst-parser sphinx-design sphinx-copybutton
+```
+
+---
+
+### Generate API documentation
+
+```bash
+poetry run sphinx-apidoc -o docs/source mechlab
+```
+
+This generates:
+
+* `modules.rst`
+* module documentation files
+
+---
+
+### Build HTML documentation
+
+```bash
+poetry run sphinx-build -b html docs/source docs/build
+```
+
+Output:
+
+```text
+docs/build/index.html
+```
+
+---
+
+### View documentation locally
+
+Open in browser:
+
+```text
+docs/build/index.html
+```
+
+---
+
+## 4. Common Sphinx Fixes
+
+### Fix: Title underline too short
+
+```rst
+MechLab Documentation
+====================
+```
+
+Underline must match title length.
+
+---
+
+### Fix: toctree document has no title
+
+Every `.rst` file **must start with a title**.
+
+```rst
+Thermodynamics
+==============
+
+.. automodule:: mechlab.thermodynamics
+   :members:
+```
+
+---
+
+### Fix: ModuleNotFoundError in autodoc
+
+Add to `docs/source/conf.py`:
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).resolve().parents[2]))
+```
+
+---
+
+## 5. GitHub Pages Deployment (Sphinx)
+
+### Create gh-pages branch
+
+```bash
+git branch gh-pages
+```
+
+---
+
+### Create Git worktree
+
+```bash
+git worktree add ../mechlab-docs gh-pages
+```
+
+Directory layout:
+
+```text
+MechLab/
+├── mechlab/        # main branch
+└── mechlab-docs/   # gh-pages branch
+```
+
+---
+
+### Copy built docs
+
+```bash
+Copy-Item docs\build\* ..\mechlab-docs\ -Recurse -Force
+```
+
+---
+
+### Disable Jekyll
+
+```bash
+cd ../mechlab-docs
+New-Item .nojekyll -Force
+```
+
+---
+
+### Commit & push docs
+
+```bash
+git add .
+git commit -m "Deploy documentation"
+git push origin gh-pages
+```
+
+---
+
+### Enable GitHub Pages
+
+GitHub → **Settings → Pages**
+
+* Source: Deploy from branch
+* Branch: `gh-pages`
+* Folder: `/ (root)`
+
+Documentation URL:
+
+```
+https://sewaksunar.github.io/mechlab/
+```
+
+---
+
+## 6. PyPI Packaging (Poetry)
+
+### Build package
+
+```bash
+poetry build
+```
+
+Artifacts:
+
+```text
+dist/
+├── mechlab-0.1.1.tar.gz
+└── mechlab-0.1.1-py3-none-any.whl
+```
+
+---
+
+## 7. PyPI Metadata Fixes
+
+### Invalid classifier (removed)
+
+```text
+Topic :: Scientific/Engineering :: Mechanical Engineering
+```
+
+❌ Not a valid PyPI classifier
+
+---
+
+### Valid classifiers used
+
+```toml
+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"
+]
+```
+
+---
+
+### License fix
+
+```toml
+license = "MIT"
+```
+
+---
+
+### Scripts fix
+
+```toml
+[project.scripts]
+dev = "scripts:docs_dev"
+```
+
+---
+
+### Update lock file
+
+```bash
+poetry lock
+```
+
+---
+
+### Validate package
+
+```bash
+poetry check
+```
+
+---
+
+### Publish to PyPI
+
+```bash
+poetry publish
+```
+
+Or build + publish:
+
+```bash
+poetry publish --build
+```
+
+---
+
+## 8. Release Checklist
+
+* [x] Docs build successfully
+* [x] Docs render locally
+* [x] GitHub Pages live
+* [x] Valid PyPI classifiers
+* [x] Poetry check passes
+* [x] Wheel & sdist built
+* [x] PyPI upload successful
+
+---
+
+## 9. Future Improvements
+
+* Versioned documentation (`/v0.2/`)
+* Read the Docs integration
+* GitHub Actions CI/CD
+* Automated PyPI releases
+* Example gallery
+* API stability guarantees
+
+---
+
+## End of DEVLOG
+
+```
+
+---
+
+If you want next, I can:
+- 🔁 automate **docs + PyPI release**
+- 🎨 improve docs theme & layout
+- 🧪 add CI testing
+- 📦 prepare **v0.2.0 roadmap**
+
+Just say the word 🚀
+```
+
+# Clear old build files to avoid confusion
+Remove-Item -Recurse -Force dist
+
+# Build and Upload
+poetry build
+poetry publish

mechlab-0.2.4/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: mechlab
+Version: 0.2.4
+Summary: Computational Mechanical Engineering Toolkit
+Project-URL: Homepage, https://github.com/sewaksunar/mechlab
+Project-URL: Documentation, https://sewaksunar.github.io/mechlab/
+Project-URL: Repository, https://github.com/sewaksunar/mechlab.git
+Project-URL: Issues, https://github.com/sewaksunar/mechlab/issues
+Author-email: Sewak Sunar <sewaksunar@hotmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: control-systems,engineering,fluid-mechanics,mechanical-engineering,scientific-computing,thermodynamics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.12
+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: kiwisolver==1.4.9
+Requires-Dist: matplotlib==3.10.8
+Requires-Dist: mpmath==1.3.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: plotly>=6.5.2
+Requires-Dist: pycairo>=1.29.0
+Requires-Dist: pygments==2.19.2
+Requires-Dist: pyparsing==3.3.2
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: scipy==1.17.0
+Requires-Dist: six==1.17.0
+Requires-Dist: sympy==1.14.0
+Requires-Dist: typing-extensions==4.15.0
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://github.com/sewaksunar/mechlab/blob/main/docs/source/_static/logo.png" width="200" alt="MechLab Logo">
+</p>
+
+![PyPI](https://img.shields.io/pypi/v/mechlab)
+![License](https://img.shields.io/pypi/l/mechlab)
+![Python](https://img.shields.io/pypi/pyversions/mechlab)
+[![docs](https://github.com/3b1b/manim/workflows/docs/badge.svg)](https://sewaksunar.github.io/mechlab/)
+<!-- [![MechLab Subreddit](https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=ff4301&label=reddit&logo=reddit)](https://www.reddit.com/r/) -->
+
+# MechLab
+
+**MechLab** is an open-source **Python library for mechanical engineering computations**, providing a unified, modular, and extensible toolkit for **students, researchers, and practicing engineers**.
+
+It brings together widely used scientific libraries under a clean, engineering-focused API for:
+
+`mechanics` `thermodynamics` `fluid mechanics` `control systems` `numerical & symbolic computation`
+
+---
+
+## Features
+
+* Mechanics (statics & dynamics)
+* Thermodynamics utilities (properties, processes, cycles)
+* Fluid mechanics calculations (dimensionless numbers, flow relations)
+* Control systems analysis
+* Symbolic & numerical computation
+* Modular and extensible architecture
+* Sphinx-based documentation with API reference
+
+---
+
+## Installation
+
+Install directly from **PyPI**:
+
+```bash
+pip install mechlab
+```
+
+Using **uv** (recommended):
+
+```bash
+uv pip install mechlab
+```
+
+---
+
+## Quick Start
+
+```python
+from mechlab.thermodynamics import enthalpy_TP
+
+h = enthalpy_TP(
+    fluid="Water",
+    T=500,        # Temperature [K]
+    P=3e6         # Pressure [Pa]
+)
+
+print(f"Enthalpy: {h:.2f} J/kg")
+```
+
+---
+
+## Package Structure
+
+```text
+mechlab/
+│
+├── mechanics/
+│   ├── __init__.py
+│   ├── statics/
+│   │   ├── stress.py
+│   │   └── strain.py
+│   └── dynamics/
+│       ├── linear_motion.py
+│       ├── rectilinear_motion.py
+│       └── motion_3d.py
+│
+├── mscience/              # Material science
+│
+├── 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 Python libraries:
+
+`numpy` `scipy` `sympy` `control` `fluids` `CoolProp` `pint` `matplotlib`
+
+All dependencies are installed automatically.
+
+---
+
+## Design Philosophy
+
+* **Engineering-first API** (clear physical meaning)
+* **Readable code** over premature optimization
+* **Modular design** — subject areas are independent
+* **Extensible** — easy to add new models & correlations
+* **Documented** — API reference generated directly from code
+
+---
+
+## Roadmap
+
+* Rankine, Otto, Diesel cycles
+* Pipe flow & heat exchanger modules
+* Full unit-aware API using Pint
+* Validation against textbook examples
+* Interactive Jupyter notebooks
+* Hosted documentation website
+
+---
+
+## Development Setup (Contributors)
+
+Clone the repository:
+
+```bash
+git clone https://github.com/sewaksunar/mechlab.git
+cd mechlab
+```
+
+Create a virtual environment and install dependencies with **uv**:
+
+```bash
+uv venv
+uv pip install -e .
+```
+
+Build documentation:
+
+```bash
+cd docs
+uv run sphinx-build source build
+```
+
+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
+
+---
+---
+
+## Documentation
+
+The documentation is built using **Sphinx** with autodoc support.
+
+Build locally:
+
+```bash
+cd docs
+uv run sphinx-build source build
+```
+
+Then open:
+
+```
+docs/build/index.html
+```
+
+---
+
+## 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!
+
+---