Repository navigation
Add documentation pages on the models - #48
Merged
Merged
Conversation
A new Models section: what every model shares (the submodels, the fluid, the enthalpy method, the surface flux law, resolved or averaged storage along the flow path, power and energy), and a page for each family, the finned tube and the packed bed, with the geometry, the equations and the options. The pages are illustrated with diagrams drawn in TikZ, in docs/models/diagrams/, sharing a preamble with the PyTES colours. The SVGs built from them are committed, so the site builds without TeX; build.py rebuilds them, and CONTRIBUTING explains how. Co-Authored-By: Claude Opus 5.5 <[email protected]>
for more information, see https://pre-commit.ci
Documentation build overview
32 files changed ·
|
The finned-tube and packed-bed notebooks link to their model page, with the sketches. Mentions of another notebook become links, each capability notebook points to the tutorial that introduces its subject, and Tutorials 2 to 5 end with a link to the next one. Tutorial 1 points to the next notebook for the finned-tube model. Co-Authored-By: Claude Opus 5.5 <[email protected]>
The list of tutorials, the pointer to the next notebook and the closing sentence become links, and the notebook ends with a link to Tutorial 2, as the others do. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Cite Luckins and Brosa Planella (2025) for the finned-tube models, and Brosa Planella (2025) and Ismail and Henríquez (2002) for the packed bed. Move the mush diagram's labels inside the PCM and use stronger tints of the PyTES Thermal colours in every diagram. Co-Authored-By: Claude Opus 5.5 <[email protected]>
for more information, see https://pre-commit.ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A new Models section in the documentation:
docs/models/index.md): what every model shares: how a model is built from submodels, the fluid equation, the enthalpy method (the melting-range form of H(T) and the liquid fraction), the surface flux law and the heat transfer coefficient options, resolved or averaged storage along the flow path, and power, energy and the initial state.docs/models/finned_tube.md): the device and the storage around one tube, a table of symbols and parameter names, the sharp-front model (composite properties, radial conduction, the wall condition) and the mush model (the PCM across the half-gap, the fin equation with its PCM source, thed_m / d_cfactor at the fin root), and the options.docs/models/packed_bed.md): the column and one capsule, spherical conduction and the couplingq' = a A h_c (T_s - T_f), lumped and Jeffreson capsules, the Wakao-Kaguei option and the parameter sets.The pages are illustrated with seven diagrams drawn in TikZ (
docs/models/diagrams/), sharing a preamble with the PyTES colours as material fills. The SVGs built from them (text as paths, so no fonts needed) are committed, so Read the Docs builds without TeX.python docs/models/diagrams/build.py [name]rebuilds them, and CONTRIBUTING explains how. The diagrams sit on a light card in both themes, opted out of the theme's dark-mode dimming.Notes for review
2 / d_csource in the fin and thed_m / d_cfactor at the root) is the easiest place to slip, so it deserves a careful look.% TODO(maintainer)at the end offinned_tube.md.https://pytes.readthedocs.io/en/latest/models/…, live once this merges.mainwhen Add a series of getting started tutorials #47 merges.Checks
sphinx-build -W --keep-goingpasses, on this branch and on Add a series of getting started tutorials #47 alone.ruff checkandruff formatpass onbuild.py.🤖 Generated with Claude Code