Skip to content

Latest commit

 

History

History
223 lines (160 loc) · 13.4 KB

CHANGELOG.md

File metadata and controls

223 lines (160 loc) · 13.4 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.11.1] - 🎨 Minor fixes and lint update - 2024-04-12

Changes
  • 🎨 lint: pre-commit autoupdate + typing fixes
  • 🐛 Fix label color for chart zones
  • 🚀 Bump patch version and update CHANGELOG

[0.11.0] - 📦️ Remove scipy dependency - 2024-04-08

Changes
  • ⚡️ Use simple 1D interpolator to project lines, instead of scipy.interpolate.interp1d
  • ✅ Add tests for convex hulls of given points
  • ⚡️ Use simple convex hull algorithm, to compute zones to group annotated points, instead of using scipy.spatial.ConvexHull
  • 📦️ Bump version, removing scipy dependency

[0.10.0] - 📦 Migrate to pydantic v2 - 2024-04-07

Move to recent versions of pydantic, and also upgrade internal linters, moving to ruff-format

Changes
  • 📦️ env: Bump version and upgrade deps, requiring pydantic v2
  • ♻️ Migrate pydantic v2 syntax for validators, parsers, serializers, model load/dump methods, etc.
  • 🎨 lint: pre-commit update, moving to ruff-format
  • 🎨 lint: Apply format changes and lint fixes
  • 📝 Update CHANGELOG
  • 👷 ci: Split actions for tests on PRs and publish package on main

[0.9.3] - ✨ Add customizable annotations - 2023-09-30

From @tadashiorigami in #44, thanks!

Changes
  • ✨ Add styling for annotations (labeled curves in the chart), customizing their font-size, color, and bbox style.
  • 🔧 Support negative constant_h_labels_loc settings, to strech the constant h line to the left inside the saturated area, giving the chart an aspect closer to the popular ASHRAE chart.
  • ✅ Add unit test with example from @tadashiorigami, with styled annotations with bbox and hack for negative constant_h_labels_loc
  • 📦️ Bump version and update matplotlib to 3.8.0

[0.9.2] - 🐛 Fix install with new pydantic v2 - 2023-07-30

Changes
  • 🎨 lint: pre-commit autoupdate
  • 📦️ env: Bump patch version and fix deps with pydantic version < v2, and enabling new Python 3.12
  • 📝 Update CHANGELOG

[0.9.1] - ✨ Add zone kind 'dbt-wmax' with vapour content limit - 2023-06-13

Changes
  • ✨ Add new kind of overlay zone 'dbt-wmax', to define chart areas delimited between db-temps and absolute humidity values, solving #28
  • 🐛 Enable zones defined by 2 points (assume a rectangle defined by left-bottom/right-top coords)
  • 🐛 Fix logic for plot regeneration, to plot again if config changes AFTER plotting the chart
  • 🐛 Fix ZoneStyle definition when linewidth is 0 and linestyle remains the default (passing inconsistent params to matplotlib)

[0.9.0] - ✨ More kinds of chart zones + CSS for SVG styling - 2023-06-12

Define new enclosed areas in chart between constant RH lines and constant volume or enthalpy values, and enable full potencial for SVG customization by including CSS and/or <defs> inside it.

Changes
  • ✨ Add new kind of overlay zones 'enthalpy-rh' and 'volume-rh', to define chart areas delimited between 2 constant enthalpy or volume lines, and 2 constant humidity lines
  • 🎨 Add chart.remove_zones() method, like the existent .remove_legend() and .remove_annotations(), to clear matplotlib current Axes from each kind of annotated objects
  • 🐛 Fix artists registry not mirroring objects in plot, by setting a new one each time chart.plot() is invoked
  • ♻️ Set gid for 'chart_legend_background' item if frameon is enabled
  • ✨ Pass optional CSS and SVG to chart.make_svg(), to include extra-styling inside the produced SVG 🌈
  • ✨ Add method chart.plot_over_saturated_zone() to create a filled patch in the over-saturated zone of the psychrochart, to colorize that area
  • 🦄 tests: Add dynamic effects and CSS rules to splash chart for a show-off of SVG styling capabilities
  • 🚀 env: Bump version and update CHANGELOG

[0.8.0] - ✨ Lazy generation of chart data, 'Artist' registry, and better SVG export - 2023-06-11

Now all chart-data parameters, including the overlayed zones, are included in the ChartConfig, and generation of curves only happens when chart is plotted (or saved to disk).

Any change in the chart configuration will trigger a data-regen for all items before plotting.

When plotting over some matplotlib Axes, all objects created have meaningful (and deterministic) ids, and are tracked and accessible under chart.artists, for easier customization of single matplotlib objects, also adding a recognizable hierarchy in generated SVGs, (enabling potential for CSS over SVG charts 🌈)

Changes
  • ✨ Name each matplotlib Artist obj in plot with custom readable IDs, for easier recognition and readable object hierarchy in SVGs, and maintain a registry of all objects in plot to access them by kind under chart.artists property, allowing fine-grain control to customize all details in the psychrochart
  • ♻️ Refactor chart 'zones' and store zone definitions in ChartConfig, to regenerate plot patches (closed PsychroCurve, with ZoneStyle) on-demand, same as the other chart curves, generating new 'xy' points when config is changed. If ChartParams.with_zones is enabled, but there are no zones in config when chart is created, the default winter/summer 'dbt-rh' zones are added.
  • ⚡️ Add lazy generation of psychro curves to avoid updating the chart data until it's needed to plot, and add a chart.process_chart() method to trigger data regeneration if the chart config has changed or there is no chart data yet
  • 💥 Make chart.saturation a single PsychroCurve, instead of a collection of curves
  • ✅ tests: Add unit tests for new ChartRegistry and adapt to behaviour changes and readable hierarchy in SVG output
  • 📝 Update example notebook showing chart.artists usage
  • 🚀 env: Update deps, bump version, and update CHANGELOG

[0.7.0] - ♻️ Testing suite refactor + model changes - 2023-06-09

Maintenance-only update, without new features.

Changes
  • 💥 Remove plotting methods from PsychroCurve/PsychroCurves for a more functional approach, using methods in plot_logic.py
  • 💥 Add PsychroCurve.internal_value field, to identify the trigger value for each curve (constant H/V/RH...), and evolve validation of data arrays
  • ✅ tests: Increase test coverage and optimize tests for faster run (~2x)
  • 📦️ env: Add slugify to deps and bump version

[0.6.0] - ✨ Chart config auto-refresh + bugfixes - 2023-06-07

Before, chart customize was done by creating a new Psychrochart object based on some modified chart configuration, so creating custom plots, or even changing chart limits, was challenging 😓

Now, when chart.config changes, any call to chart.save(), chart.make_svg(), or chart.plot() will regenerate the chart data (limits, enabled curves, styling, etc.) before plotting, with only the visible curves inside limits, (no more 0-size artifacts in SVGs, and most errors because some var is out of range should be gone now 🤞)

Changes
  • ♻️ Update example notebook with API changes, and using chart.make_svg() as the recommended method to generate SVGs
  • 💄 Parse colors into RGBA values, so "red", "#FF0000", "#FF0000FF" produce the same float repr [1., 0., 0., 1.]
  • 🏗️ Add mutation control for configuration models, and use it to check if there is any config change before creating a chart, triggering a chart-data regeneration if necessary
  • 🔧 Add new field ChartFigure.dpi to chart config, for easy customization of matplotlib Figure DPI
  • ⚡️ Optimize generation of psychrometric curves inside plot limits

[0.5.0] - ♻️ Full re-work on internals to use pydantic models - 2023-06-05

🧹 Internal evolution to update the code style to the latest versions and de facto standards, with better typing, input validation, and serialization. Hardly any new features, but some bug fixes.

Changes

  • 🏗️ Add pydantic models for chart + annotations styling and config, for better (de)serialization and parameter validation.

    New models are:

    • CurveStyle, LabelStyle, TickStyle, ZoneStyle := to parse & handle defaults for matplotlib styling parameters
    • ChartConfig for the full chart configuration, including sub-models ChartFigure, ChartLimits, and ChartParams, to mirror the old obfuscated config, with the same default values as before
    • ChartPoint and ChartSeries for styled single-point or array-data annotations
    • ChartLine for styled connectors between named points (now without outline 'marker' by default)
    • ChartArea for styled convex areas delimited by a list of named points
    • ChartAnnots as container for all of the above
    • ChartZone (and ChartZones as a list), for styled fixed areas (like the default winter/summer comfort zones)

  • ♻️ Evolve load methods to parse inputs into pydantic models with near-zero (expected 🤞) breaks when reading old data

  • 💥 Rework PsychroChart class to work with pydantic PsychroChartModel. As the chart is now a pydantic model, there is a chart.json(...) method, and loading from serialized data is available with PsychroChart.parse_file( / .validate( / etc 🤩

    BREAKING-CHANGE: Now the chart creation from a configuration key/file/dict is done with PsychroChart.create(config), instead of old PsychroChart(config)

  • ✨ Add .make_svg() method to produce a SVG file as text, and evolve .save(...) with optional canvas_cls: Type[FigureCanvasBase], to select kind of matplotlib canvas where to print the chart

  • ✨ Support file creation in subfolders with chart.save(dest)

  • 🚚 rsc: Deterministic SVG output in tests, and README images without date metadata

  • ✅ tests: Adapt API changes in unit tests, remove usages of unittest.TestCase, add new tests for pydantic models, annotations, and serialization methods.

[0.4.0] - ♻️ Maintenance update to upgrade used libraries

Changes

  • 🐛 (from @simplynail in #25): fixing chart setup error with gca() call for recent Matplotlib versions
  • 🙈 Add missing .gitignore
  • 💥 Update dependencies + minimal Python version to 3.10 to work with latest releases 🏄
  • 🎨 lint: Apply isort and prettier, and update typing
  • 🎨 lint: Evolve pre-commit config with ruff
  • 🍱 tests: Update SVG outputs from latest matplotlib
  • 🐛 Fix saving PNG with transparent background, by swapping transparent=True with facecolor="none"
  • 🗑️ Use psychrolib.GetTDryBulbFromMoistAirVolumeAndHumRatio, removing local method from here, now that it's included there
  • 👷 ci: Swap travis CI config with GH actions to test + publish

[0.3.1] - 2019-11-12

Changed

  • Fixed plotting of zones

[0.3.0] - 2019-11-12

Added

  • Add boolean to switch to IP units
  • Add new predefined style "ashrae_ip" in IP units
  • Add pyproject.toml file and use poetry to manage the package and travis CI

Changed

  • Rely on psychrolib for psychrometric equations
  • Reformat code to adapt to current standards (black and stricter flake8 lint checks)
  • Refactor chart.py into multiple modules:
    • Move PsychroCurve(s) classes definitions to separate module
    • Rename equations to .chartdata and move there all logic for curve data generation
  • Adapt tests and do some code cleaning
  • Redo internal units for pressure (from kPa to Pa) and enthalpy (from KJ/kg to J/kg) to use IP units
  • Adapt plots to use labels, ticks, etc as function of selected unit system.
  • Use numpy instead of lists and vectorize psychrometric operations

Removed

  • Own collection of psychrometric equations

[< 0.2.7] - Old versions changelog

  • v0.1.0: Initial version.
  • v0.1.1: Minor plotting fixes, set axis position, define P with altitude_m or pressure_kpa, reuse plot removing annotations (chart.remove_annotations). Axes as internal prop, lazy plotting, save to disk helper (chart.save).
  • v0.1.2: Add agg module to set that matplotlib backend.
  • v0.1.3: Add custom params for plotting styles, option to exclude first and last tick (constant_{humid/temp}_label_include_limits).
  • v0.1.4: Customize labels and its locations for families of psychrometric curves.
  • v0.1.5: Add Arrows, compatibility with the Home Assistant component psychrometrics.
  • v0.1.6: Some cleaning, better typing, flake8, added tox.ini.
  • v0.1.7: Methods to clean the plot (.close_fig()) and to remove the legend (.remove_legend()).
  • v0.1.8: Memleak with savefig.
  • v0.1.10: Fix plot limits, do not use pyplot, axes are not optional.
  • v0.1.11: Add optional Axes as argument for PsychroChart.plot.
  • v0.1.12: Add empiric equation for wet bulb temperature (@ZhukovGreen contribution).
  • v0.1.13: Add convex hull option for overlay points.
  • v0.2.0: Hide output in verbose mode, better convex hull zones syntax, stable.
  • v0.2.1: Make scipy an optional requirement (it's only used for the ConvexHull zone).
  • v0.2.2: Fix initial conditions for iteration solvers
  • v0.2.3: Handle ConvexHull exception, overlay of series of points.
  • v0.2.4: Set ASHRAE formulation for saturation_pressure_water_vapor as default. Minimal adjustments to iteration solvers for enthalpy and specific volume.
  • v0.2.5: Fix coefficient in ASHRAE formulation for dew_point_temperature.
  • v0.2.6: Add labels for connectors in chart legend (@@zhang-shen contribution).