fluids-book

Enforces project conventions for building tested Python modules, notebooks, and explainers from a fluid mechanics textbook.

Updated Sep 13, 2026
One-click install
npx skills add https://github.com/shammun/fluidpy --skill fluids-book-shammun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fluids-book
Source: https://github.com/shammun/fluidpy/tree/main/.claude/skills/fluids-book
Command: npx skills add https://github.com/shammun/fluidpy --skill fluids-book-shammun

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? It keeps every chapter of the fluidpy project consistent by codifying file naming, docstring contracts, units and notation rules, validation vocabulary, curation tiers, and the definition of done for chapter work. ## Core Features & Use Cases - Project conventions: Defines chapter IDs, module/test/notebook/explainer file naming, and the role of core primitives and knowledge files. - Docstring and validation contract: Requires every function to cite book equations, list units, state assumptions, and declare a validation level (analytic, symbolic, converged, conserved, benchmark). - Curation tiers and done criteria: Specifies CORE/NOTE/RECAP/SKILL tiers for exhaustive book coverage and a six-step checklist for chapter completion. - Use Case: When implementing Chapter 7 gravity waves, load this Skill to name files correctly, write compliant docstrings, and know exactly what must pass before the chapter is done. ## Quick Start Load the fluids-book conventions before implementing or reviewing any chapter module, test, notebook, or explainer in this repository.

Frequently Asked Questions about fluids-book

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure a new chapter module in the fluidpy project?

Create fluidpy/chNN_<slug>.py with the slug from book.yaml, plus tests/test_chNN.py, a notebook builder notebooks/build_chNN.py, and 4-5 explainers under viz/chNN/. Every computable CORE and NOTE item must be implemented with compliant docstrings.

What must a docstring contain for fluidpy functions?

Each docstring cites the book section and equation numbers, lists every parameter with SI units, states assumptions, and declares a validation label such as analytic, symbolic, converged, conserved, or benchmark with the evidence used.

What validation levels does the fluidpy project use?

The vocabulary is analytic (V1), symbolic (V2), converged (V3), conserved (V4), benchmark (V5, cited), book-value (V6, private), qualitative, and unverified. Computable CORE items need at least two evidence levels; unverified blocks a PASS unless justified.

Can I commit book text or figures to the fluidpy repository?

No. The repo is public, so book text, page images, figure crops, transcribed tables, and book-quoted numbers must never be committed. Equations may be shown with their numbers, explanations are original, and figures are generated by project code.

When is a fluidpy chapter considered done?

A chapter is done when analysis and curation files exist, the module implements all computable items, tests and verification reports pass, 4-5 explainers pass lint and screenshot checks, the notebook executes headlessly with full coverage, and the published pages pass the public check.