driven-pile 0.1.0__tar.gz

driven_pile-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync --group dev
+      - run: uv run ruff check src tests
+      - run: uv run pytest -q -m "not slow"
+
+  slow:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+      - run: uv sync --group dev
+      - run: uv run pytest -q -m slow

driven_pile-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,103 @@
+name: CI Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-docs:
+    name: "Build Docs"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0 # Full history for accurate page timestamps
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install package and dependencies
+        run: |
+          python -m pip install uv
+          uv sync --group docs
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Install STIX Two Text for the example figures
+        run: |
+          mkdir -p ~/.local/share/fonts
+          for style in Regular Italic Bold BoldItalic; do
+            curl -fsSL -o ~/.local/share/fonts/STIXTwoText-$style.otf \
+              https://raw.githubusercontent.com/stipub/stixfonts/v2.13/fonts/static_otf/STIXTwoText-$style.otf
+          done
+          fc-cache -f
+
+      - name: Build docs
+        run: uv run great-docs build
+
+      - name: Save docs artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: docs-html
+          path: docs/_site
+          include-hidden-files: true
+
+      - name: How to preview this build locally
+        if: github.event_name == 'pull_request'
+        run: uv run great-docs ci notice --run ${{ github.run_id }} --pr ${{ github.event.number }}
+
+      - name: Upload build timings
+        uses: actions/upload-artifact@v7
+        with:
+          name: build-timings
+          path: docs/_site/build-timings.json
+
+  publish-docs:
+    name: "Publish Docs"
+    runs-on: ubuntu-latest
+    needs: "build-docs"
+    if: github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/download-artifact@v7
+        with:
+          name: docs-html
+          path: docs/_site
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/_site
+          include-hidden-files: true
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5
+
+  preview-docs:
+    name: "Preview Docs"
+    runs-on: ubuntu-latest
+    needs: "build-docs"
+    if: github.event_name == 'pull_request'
+    permissions:
+      pull-requests: write
+    steps:
+      # Post (and keep updated) a sticky PR comment with the local-preview
+      # command, pinned to this run so it reproduces the build under review.
+      # Runs the released great-docs via pipx (no install step needed); kept as
+      # its own minimal job so the docs build never holds a pull-requests:write
+      # token. continue-on-error so fork PRs (read-only token) don't fail the run.
+      - name: Post preview instructions to the PR
+        continue-on-error: true
+        run: pipx run great-docs ci pr-comment --run ${{ github.run_id }} --pr ${{ github.event.number }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

driven_pile-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

driven_pile-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+__pycache__/
+*.pyc
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.DS_Store
+
+# Great Docs build directory (ephemeral, do not commit)
+great-docs/
+
+# Great Docs versioned-build artifacts
+_great_docs_build/
+.great-docs-build/
+.great-docs-cache/
+.great-docs/
+
+# Great Docs build output
+/docs/_quarto/
+/docs/_site/
+/docs/.cache/
+/.great-docs-build/
+/.great-docs/
+/docs/_freeze/

driven_pile-0.1.0/CLAUDE.md

@@ -0,0 +1,51 @@
+# Working agreement for driven-pile
+
+## What this is
+
+A pip-installable Python library that estimates the long-term capacity of a
+driven pile from its driving log by tracking the pore pressure generated by
+hammer blows. It was extracted from the research repository
+`TCE_499_pile-driving` (branch clean-rebuild, tag `paper-freeze-2026-10-23`),
+which stays the home of the data and the soil-classification work. Soil classification is out of scope here.
+
+Read llm/no_paper_citation.md before writing any user-facing text,
+llm/api_design.md before changing the public API, and llm/status.md for where
+the work stands.
+
+## Rules
+
+- Implement only the method as it stands. A model-form change needs a
+  published precedent, cited in the function's References section.
+- Never cite Arnold (2027) or its equation numbers in the README, docs,
+  docstrings or package metadata (llm/no_paper_citation.md).
+- Never use FHWA table setup factors; the method derives everything from the
+  log and the site inputs.
+- Long-term capacity is always shaft plus the end-of-drive toe. Never add a
+  toe-setup variant.
+- The deterministic top-segment friction angle is the lowest admissible value
+  of the sweep.
+- Do not git commit or push unless Lorne asks. Leave changes in the working
+  tree and say what is uncommitted.
+- Keep executing evident next steps; stop only for decisions that are Lorne's
+  (model-form choices, scope, anything irreversible) or when blocked.
+
+## Code conventions
+
+- numpy docstring convention with Parameters, Returns, Notes and References;
+  equation-level functions cite the original published source.
+- PEP 8, type hints on public signatures, dataclasses for records, no
+  module-level state, no file-system conventions inside the library.
+- Comments describe what the code does. Design rationale and history go in
+  docs/, never in source files.
+- Units: feet, kips, ksf, degrees throughout.
+- Results are dataclasses of plain numpy arrays. No pandas dependency.
+  matplotlib is an optional extra used only by the plot helpers.
+- Tests: pytest. `uv run pytest -q -m "not slow"` is the fast suite
+  (about 15 s); `-m slow` sweeps every benchmark pile's top band (about 2 min).
+  `uv run ruff check src tests` must pass.
+
+## Reporting
+
+- Expand every acronym once per summary.
+- Report results that weaken the method as plainly as results that support it.
+- When verifying a change against the research code, show the comparison.