bstart-trb 0.1.0__tar.gz → 0.2.0__tar.gz

bstart_trb-0.2.0/.python-version

@@ -0,0 +1 @@
+3.11

bstart_trb-0.2.0/BUILDING.md

@@ -0,0 +1,117 @@
+# Building Guide
+
+This guide explains how to build `bstart-trb` wheel packages for distribution.
+
+## Prerequisites
+
+### Windows
+
+1. **Install MSYS2** (provides gfortran):
+   - Download from https://www.msys2.org/
+   - After installation, open MSYS2 terminal and run:
+     ```bash
+     pacman -S mingw-w64-ucrt-x86_64-gcc-fortran
+     ```
+   - Add `C:\msys64\ucrt64\bin` to your system PATH
+
+2. **Install Python 3.10+**:
+   - Download from https://www.python.org/downloads/
+
+3. **Install uv** (recommended):
+   ```powershell
+   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+   ```
+
+### macOS
+
+```bash
+# Install gfortran
+brew install gfortran
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### Linux
+
+```bash
+# Install gfortran
+sudo apt install gfortran  # Debian/Ubuntu
+sudo yum install gcc-gfortran  # RHEL/CentOS
+
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+---
+
+## Build Steps
+
+### 1. Clone the repository
+
+```bash
+git clone https://github.com/youjunxiaji/bstart-trb.git
+cd bstart-trb
+```
+
+### 2. Install dependencies with uv
+
+```bash
+uv sync
+```
+
+This automatically creates a virtual environment and installs all dependencies.
+
+### 3. Build the wheel
+
+```bash
+uv run python -m build --wheel
+```
+
+The wheel file will be created in the `dist/` directory.
+
+---
+
+## Alternative: Direct f2py Build
+
+If meson build fails, you can compile the Fortran module directly:
+
+```bash
+cd slice_wrapper
+uv run python -m numpy.f2py -c taper_slice.f90 -m _taper_slice
+```
+
+---
+
+## Publishing to PyPI
+
+### 1. Install twine
+
+```bash
+uv pip install twine
+```
+
+### 2. Create PyPI API token
+
+1. Log in to https://pypi.org
+2. Go to Account settings → API tokens → Add API token
+3. Save the token securely
+
+### 3. Upload the wheel
+
+```bash
+uv run twine upload dist/*.whl
+```
+
+When prompted:
+- Username: `__token__`
+- Password: Your API token (starts with `pypi-`)
+
+---
+
+## Notes
+
+- Each Python version (3.10, 3.11, 3.12) needs a separate wheel
+- Windows wheels have `.whl` suffix like `*-win_amd64.whl`
+- macOS wheels: `*-macosx_*_arm64.whl` (Apple Silicon) or `*-macosx_*_x86_64.whl` (Intel)
+- Linux wheels: `*-manylinux*.whl`

bstart_trb-0.2.0/PACKAGE_SUMMARY.md

@@ -0,0 +1,208 @@
+# bstart-trb PyPI 包配置总结
+
+## 完成的工作
+
+### 1. 包配置 (`pyproject.toml`)
+
+✅ **配置内容**：
+- 包名：`bstart-trb`
+- 版本：`0.1.0`
+- 描述：Cylindrical/Tapered Roller Bearing Slice Stress Calculation Module
+- Python 版本：>= 3.12
+- 许可证：MIT
+- 依赖：仅 `numpy >= 2.0.0`
+
+✅ **构建配置**：
+- 使用 `hatchling` 作为构建后端
+- 仅打包 `slice_wrapper` 目录
+- 包含预编译的二进制文件（`.pyd`）
+- 排除 Fortran 源码（`.f90`）和构建脚本（`build.py`）
+
+### 2. 文件修改
+
+✅ **新增文件**：
+- `README_PYPI.md` - PyPI 包说明文档（英文）
+- `PUBLISHING.md` - 发布指南（中文）
+- `test_install.py` - 安装测试脚本
+- `PACKAGE_SUMMARY.md` - 本文件
+
+✅ **修改文件**：
+- `pyproject.toml` - 完整的包配置
+- `.gitignore` - 允许跟踪 `.pyd` 文件
+- `slice_wrapper/__init__.py` - 版本号改为 0.1.0
+
+✅ **添加到 Git**：
+- `slice_wrapper/_taper_slice.cp312-win_amd64.pyd` - 预编译的 Fortran 模块
+
+### 3. 构建和测试
+
+✅ **构建结果**：
+```
+dist/
+├── bstart_trb-0.1.0-py3-none-any.whl    # Wheel 包
+└── bstart_trb-0.1.0.tar.gz              # 源码包
+```
+
+✅ **包内容验证**：
+- ✅ Python 源码文件
+- ✅ 预编译的 `.pyd` 文件（139 KB）
+- ✅ 类型提示文件（`.pyi`）
+- ✅ LICENSE 文件
+- ❌ Fortran 源码（已排除）
+- ❌ 构建脚本（已排除）
+
+✅ **功能测试**：
+```
+[OK] 包版本: 0.1.0
+[OK] Fortran 模块可用: True
+[OK] 收敛: True
+[OK] 错误码: 0
+[OK] 滚子变形: 0.006387 mm
+[OK] 平衡载荷: 1338.12 N
+[OK] 最大应力: 1299 MPa
+[SUCCESS] 所有测试通过!
+```
+
+## 包的特点
+
+### ✅ 优点
+
+1. **无需编译**：用户安装时不需要 Fortran 编译器
+2. **开箱即用**：pip 安装后立即可用
+3. **保密源码**：不包含 Fortran 源代码
+4. **类型安全**：完整的类型提示
+5. **体积小**：仅约 150 KB
+
+### ⚠️ 限制
+
+1. **平台限制**：当前只支持 Windows x64
+2. **Python 版本**：仅支持 Python 3.12
+3. **扩展性**：添加新平台需要重新编译
+
+## 安装和使用
+
+### 用户安装
+
+```bash
+pip install bstart-trb
+```
+
+### 快速开始
+
+```python
+from slice_wrapper import (
+    slice_stress,
+    RollerParams,
+    RacewayParams,
+    CrownType,
+    RacewayType,
+)
+
+# 定义参数
+roller = RollerParams(
+    d1=10.0, d2=10.0, length=9.6,
+    crown_type=CrownType.LOGARITHMIC,
+    curve_q=14100.0
+)
+
+raceway = RacewayParams(
+    diameter=-150.0,
+    raceway_type=RacewayType.OUTER
+)
+
+# 计算
+result = slice_stress(roller, raceway, load=1340.86, n_slice=30)
+print(f"Max stress: {result.max_stress:.0f} MPa")
+```
+
+## 发布流程
+
+### 1. 测试 PyPI（推荐）
+
+```bash
+# 上传到测试环境
+uv run twine upload --repository testpypi dist/*
+
+# 测试安装
+pip install --index-url https://test.pypi.org/simple/ \
+    --extra-index-url https://pypi.org/simple/ bstart-trb
+```
+
+### 2. 生产 PyPI
+
+```bash
+# 上传到生产环境
+uv run twine upload dist/*
+```
+
+### 3. Git 标签
+
+```bash
+git commit -m "v0.1.0  发布到 PyPI"
+git tag v0.1.0
+git push origin main --tags
+```
+
+## 后续工作
+
+### 可选优化
+
+1. **多平台支持**：
+   - 在 Linux 上编译 `.so` 文件
+   - 在 macOS 上编译 `.so` 文件
+   - 上传多个平台特定的 wheel
+
+2. **多 Python 版本**：
+   - 在 Python 3.11, 3.13 等版本下编译
+   - 上传多个版本特定的 wheel
+
+3. **CI/CD**：
+   - 设置 GitHub Actions 自动构建
+   - 自动测试和发布
+
+4. **文档**：
+   - 添加 Sphinx 文档
+   - 发布到 Read the Docs
+
+## 文件清单
+
+### 项目根目录
+```
+bstart-trb/
+├── slice_wrapper/                    # 主包目录
+│   ├── __init__.py                  # 包初始化（版本 0.1.0）
+│   ├── models.py                    # 数据模型
+│   ├── wrapper.py                   # Python 包装器
+│   ├── _taper_slice.pyi             # 类型提示
+│   ├── py.typed                     # PEP 561 标记
+│   ├── _taper_slice.cp312-win_amd64.pyd  # 预编译模块 ⭐
+│   ├── taper_slice.f90              # Fortran 源码（不打包）
+│   └── build.py                     # 构建脚本（不打包）
+├── dist/                            # 构建产物
+│   ├── bstart_trb-0.1.0-py3-none-any.whl
+│   └── bstart_trb-0.1.0.tar.gz
+├── pyproject.toml                   # 包配置 ⭐
+├── README_PYPI.md                   # PyPI 说明 ⭐
+├── PUBLISHING.md                    # 发布指南 ⭐
+├── test_install.py                  # 测试脚本 ⭐
+├── PACKAGE_SUMMARY.md               # 本文件 ⭐
+├── LICENSE                          # MIT 许可证
+├── .gitignore                       # Git 忽略（已修改）⭐
+└── uv.lock                          # 依赖锁定
+
+⭐ = 新增或重要修改的文件
+```
+
+## 参考文档
+
+- **用户文档**：`README_PYPI.md`
+- **发布指南**：`PUBLISHING.md`
+- **构建文档**：`BUILDING.md`
+- **原始说明**：`README.md`（中文技术文档）
+
+## 联系方式
+
+- 作者：Gu Lei
+- 许可证：MIT
+- Python 版本：>= 3.12
+- 平台：Windows x64