{"id":17657376,"url":"https://github.com/azogue/psychrochart","last_synced_at":"2025-04-12T15:41:45.071Z","repository":{"id":57455369,"uuid":"96488502","full_name":"azogue/psychrochart","owner":"azogue","description":"A Python 3 library to make psychrometric charts and overlay information on them.","archived":false,"fork":false,"pushed_at":"2025-03-03T19:24:00.000Z","size":35143,"stargazers_count":111,"open_issues_count":13,"forks_count":27,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-03T19:12:42.946Z","etag":null,"topics":["climate-zone","humidity-control","hvac","matplotlib","moisture","psychrometric","psychrometric-chart","psychrometrics","python3"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/azogue.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-07T01:57:26.000Z","updated_at":"2025-03-01T03:52:11.000Z","dependencies_parsed_at":"2023-11-23T10:28:59.268Z","dependency_job_id":"1f9b3234-64f3-44a1-a3ba-014f5185024c","html_url":"https://github.com/azogue/psychrochart","commit_stats":{"total_commits":263,"total_committers":8,"mean_commits":32.875,"dds":"0.10646387832699622","last_synced_commit":"efe3ecf30dfbb3ee05f4e6123d49abf1ddb5b5e1"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azogue%2Fpsychrochart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azogue%2Fpsychrochart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azogue%2Fpsychrochart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azogue%2Fpsychrochart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/azogue","download_url":"https://codeload.github.com/azogue/psychrochart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248590871,"owners_count":21129904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["climate-zone","humidity-control","hvac","matplotlib","moisture","psychrometric","psychrometric-chart","psychrometrics","python3"],"created_at":"2024-10-23T14:40:33.338Z","updated_at":"2025-04-12T15:41:45.041Z","avatar_url":"https://github.com/azogue.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![pre-commit.ci Status][pre-commit-ci-image]][pre-commit-ci-url]\n[![Build Status][build-image]][build-url]\n[![PyPI Version][pypi-image]][pypi-url]\n\n\u003c!-- Badges --\u003e\n\n[pre-commit-ci-image]: https://results.pre-commit.ci/badge/github/azogue/psychrochart/master.svg\n[pre-commit-ci-url]: https://results.pre-commit.ci/latest/github/azogue/psychrochart/master\n[build-image]: https://github.com/azogue/psychrochart/actions/workflows/main.yml/badge.svg\n[build-url]: https://github.com/azogue/psychrochart/actions/workflows/main.yml\n[pypi-image]: https://img.shields.io/pypi/v/psychrochart\n[pypi-url]: https://pypi.org/project/psychrochart/\n\n# Psychrochart\n\nA python 3 library to make **[psychrometric charts](https://en.wikipedia.org/wiki/Psychrometrics)** and overlay information on them.\n\nIt implements a useful collection of psychrometric equations for moisture and humid air calculations, and the generation of beautiful and high customizable **psychrometric charts in SVG** with [`matplotlib`](https://matplotlib.org).\n\n**Psychrometric calculations to make the chart data are done with [`PsychroLib`](https://github.com/psychrometrics/psychrolib)** (summary paper in https://doi.org/10.21105/joss.01137).\n\n\u003cimg src=\"./tests/example-charts/chart_overlay_style_minimal.svg\" width=\"100%\" height=\"100%\"\u003e\n\n## Install\n\nGet it **[from pypi](https://pypi.python.org/pypi?:action=display\u0026name=psychrochart)** or **[clone it](https://github.com/azogue/psychrochart.git)** if you want to run the tests.\n\n```shell\npip install psychrochart\n```\n\n## Features\n\n- **SI** units (with temperatures in celsius for better readability), with _partial_ compatibility with IP system (imperial units)\n- Easy style customization based on [**pydantic**](https://docs.pydantic.dev/latest/) models and config presets for full customization of **chart limits**, included lines and labels, colors, line styles, line widths, etc..\n- Psychrometric charts within temperature and humidity ratio ranges, for any pressure\\*, with:\n  - **Saturation line**\n  - **Constant RH lines**\n  - **Constant enthalpy lines**\n  - **Constant wet-bulb temperature lines**\n  - **Constant specific volume lines**\n  - **Constant dry-bulb temperature lines** (internal orthogonal grid, vertical)\n  - **Constant humidity ratio lines** (internal orthogonal grid, horizontal)\n- Plot legend for each family of lines, labeled zones and annotations\n- Specify labels for each family of lines\n- Overlay points, arrows, **data-series** (numpy arrays or pandas series), and convex hulls around points\n- Define multiple kinds of **zones limited by psychrometric values**:\n  - 'dbt-rh' for areas between dry-bulb temperature and relative humidity values,\n  - 'enthalpy-rh' for areas between constant enthalpy and relative humidity values\n  - 'volume-rh' for areas between constant volume and relative humidity values\n  - 'dbt-wmax' for an area between dry-bulb temperature and water vapor content values (:= a rectangle cut by the saturation line),\n  - 'xy-points' to define arbitrary closed paths in plot coordinates (dbt, abs humidity)\n- **Export as SVG, PNG files**, or generate dynamic SVGs with extra CSS and \u003cdefs\u003e with `chart.make_svg(...)`\n\n\u003e NOTE: The ranges of temperature, humidity and pressure where this library should provide good results are within the normal environments for people to live in.\n\u003e\n\u003e Don't expect right results if doing other type of thermodynamic calculations.\n\u003e\n\u003e ⚠️ **Over saturated water vapor states are not implemented**. This library is intended for HVAC applications only ⚠️\n\n## Usage\n\n```python\nfrom psychrochart import PsychroChart\n\n# Load default style:\nchart_default = PsychroChart.create()\n# customize anything\nchart_default.config.limits.range_temp_c = (15.0, 35.0)\nchart_default.config.limits.range_humidity_g_kg = (5, 25)\nchart_default.config.saturation.linewidth = 1\nchart_default.config.constant_wet_temp.color = \"darkblue\"\n# plot\naxes = chart_default.plot()\naxes.get_figure()\n# or store on disk\nchart_default.save(\"my-custom-chart.svg\")\n```\n\nCalled from the terminal (`python psychrochart`), it plots and shows the default chart using the default matplotlib backend, equivalent to this python script:\n\n```python\nfrom psychrochart import PsychroChart\nimport matplotlib.pyplot as plt\n\nPsychroChart.create().plot(ax=plt.gca())\nplt.show()\n```\n\n### Chart customization\n\nThe default styling for charts is defined in JSON files that you can change, or you can pass a path of a file in JSON, or a dict, when you create the psychrometric chart object.\nIncluded styles are: `default`, `ashrae`, `ashrae_ip` (adjusted for IP units), `interior`, and `minimal`.\n\n```python\nfrom pathlib import Path\nfrom psychrochart import load_config, PsychroChart\n\n# Load preconfigured styles:\nchart_ashrae_style = PsychroChart.create('ashrae')\nchart_ashrae_style.plot()\n\nchart_minimal = PsychroChart.create('minimal')\nchart_minimal.plot()\n\n# Get a preconfigured style model and customize it\nchart_config = load_config('interior')\nchart_config.limits.range_temp_c = (18.0, 32.0)\nchart_config.limits.range_humidity_g_kg = (1.0, 40.0)\nchart_config.limits.altitude_m = 3000\n\ncustom_chart = PsychroChart.create(chart_config)\ncustom_chart.save(\"custom-chart.svg\")\n\n# serialize the config for future uses\nassert chart_config.json() == custom_chart.config.json()\nPath('path/to/chart_config_file.json').write_text(chart_config.json())\ncustom_chart_bis = PsychroChart.create('path/to/chart_config_file.json')\n# or even the full psychrochart\nPath('path/to/chart_file.json').write_text(custom_chart.json())\ncustom_chart_bis_2 = PsychroChart.parse_file('path/to/chart_file.json')\n\n# Specify the styles JSON file:\nchart_custom = PsychroChart.create('/path/to/json_file.json')\nchart_custom.plot()\n\n# Pass a dict with the changes wanted:\ncustom_style = {\n    \"figure\": {\n        \"figsize\": [12, 8],\n        \"base_fontsize\": 12,\n        \"title\": \"My chart\",\n        \"x_label\": None,\n        \"y_label\": None,\n        \"partial_axis\": False\n    },\n    \"limits\": {\n        \"range_temp_c\": [15, 30],\n        \"range_humidity_g_kg\": [0, 25],\n        \"altitude_m\": 900,\n        \"step_temp\": .5\n    },\n    \"saturation\": {\"color\": [0, .3, 1.], \"linewidth\": 2},\n    \"constant_rh\": {\"color\": [0.0, 0.498, 1.0, .7], \"linewidth\": 2.5,\n                    \"linestyle\": \":\"},\n    \"chart_params\": {\n        \"with_constant_rh\": True,\n        \"constant_rh_curves\": [25, 50, 75],\n        \"constant_rh_labels\": [25, 50, 75],\n        \"with_constant_v\": False,\n        \"with_constant_h\": False,\n        \"with_constant_wet_temp\": False,\n        \"with_zones\": False\n    },\n    \"constant_v_annotation\": {\n        \"color\":[0.2, 0.2, 0.2],\n        \"fontsize\":7,\n        \"bbox\": dict(boxstyle=\"square,pad=-0.2\", color=[1, 1, 1, 0.9], lw=0.5)\n    },\n    \"constant_h_annotation\": {\n        \"color\":[0.2, 0.2, 0.2],\n        \"fontsize\":6,\n        \"bbox\": dict(boxstyle=\"square,pad=-0.1\", color=[1, 1, 1, 0.9], lw=0.5)\n    },\n    \"constant_wet_temp_annotation\": {\n        \"color\":[0.2, 0.2, 0.2],\n        \"fontsize\":7,\n        \"bbox\": dict(boxstyle=\"square,pad=0\", color=[1, 1, 1, 0.9], lw=0.5)\n    },\n    \"constant_rh_annotation\": {\n        \"color\":[0.2, 0.2, 0.2],\n        \"fontsize\":7,\n        \"bbox\": dict(boxstyle=\"square,pad=0\", color=[1, 1, 1, 0.9], lw=0.5)\n    }\n}\n\nchart_custom_2 = PsychroChart.create(custom_style)\nchart_custom_2.plot()\n```\n\nThe custom configuration does not need to include all fields, but only the fields you want to change.\n\nTo play with it and see the results, look at this **[notebook with usage examples](https://github.com/azogue/psychrochart/blob/master/notebooks/Usage%20example%20of%20psychrochart.ipynb)**.\n\n## Development and testing\n\nTo run the tests, clone the repository, `poetry install` it, and run `poetry run pytest`.\n\nRun `poetry run pre-commit run --all-files` to apply linters for changes in the code 😜.\n\n## License\n\n[MIT license](https://github.com/azogue/psychrochart/blob/master/LICENSE), so do with it as you like ;-)\n\n## Included styling examples\n\n**Default style**:\n\n\u003cimg src=\"./tests/example-charts/test_default_psychrochart.svg\" width=\"100%\" height=\"100%\"\u003e\n\n**ASHRAE Handbook black and white style**: (preset: `ashrae`)\n\n\u003cimg src=\"./tests/example-charts/test_ashrae_psychrochart.svg\" width=\"100%\" height=\"100%\"\u003e\n\n**ASHRAE Handbook black and white style (IP units)**: (preset: `ashrae_ip`)\n\n\u003cimg src=\"./tests/example-charts/test_ashrae_psychrochart_ip.svg\" width=\"100%\" height=\"100%\"\u003e\n\n**Minimal style**: (preset: `minimal`)\n\n\u003cimg src=\"./tests/example-charts/test_minimal_psychrochart.svg\" width=\"100%\" height=\"100%\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazogue%2Fpsychrochart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazogue%2Fpsychrochart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazogue%2Fpsychrochart/lists"}