Skip to content

v0.2.1

Choose a tag to compare

@dogusariturk dogusariturk released this 15 May 04:08
· 113 commits to main since this release

eagar-tsai v0.2.1 Release Notes

Overview

This release is a maintenance and correctness update. The ambient temperature constant is corrected from 300 K to 298 K, a plot axis label bug is fixed, and citation metadata is added to make the package formally citable. The documentation also receives several improvements, including LaTeX-rendered equations with MathJax support on the methodology page and an updated Temperature Field Visualization guide.

Highlights

  • Ambient temperature correction: _T0_K in _types.py is updated from 300 K to 298 K (standard room temperature). All downstream computations that rely on the ambient reference temperature, including the temperature rise formula and domain sizing heuristics, are affected by this change. Documentation and docstrings are updated accordingly.
  • Plot axis label fix: A bug in plot.py where the x- and y-axis labels were incorrectly assigned is resolved. Both the surface (T_xy) and depth (T_xz) panels now display the correct spatial axis labels.
  • Citation support: A CITATION.cff file is added to the repository root, a BibTeX entry is included in the README, and a DOI badge is displayed in both the README and the documentation site, making the package formally citable in academic work.
  • Documentation improvements: The methodology page now renders mathematical expressions using LaTeX notation with MathJax, replacing plain-text approximations. The Temperature Field Visualization guide and the README are also updated to reflect the current API and output.
  • Dependency updates: Routine bumps to uv-pre-commit (0.11.7 to 0.11.14), ruff-pre-commit (0.15.11 to 0.15.12), ty (0.0.32 to 0.0.35), matplotlib (3.10.8 to 3.10.9), pandas (3.0.2 to 3.0.3), and j178/prek-action (2.0.2 to 2.0.3).

Full Changelog: v0.2.0...v0.2.1