Skip to main content

pre-commit.ci Status Build Status PyPI Version

Psychrochart

A python 3 library to make psychrometric charts and overlay information on them.

It 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.

Psychrometric calculations to make the chart data are done with PsychroLib (summary paper in https://doi.org/10.21105/joss.01137).

Install

Get it from pypi or clone it if you want to run the tests.

pip install psychrochart

Features

  • SI units (with temperatures in celsius for better readability).
  • Easy style customization with a JSON template (colors, line styles and line widths).
  • Psychrometric charts within temperature and humidity ratio ranges, for any pressure*, with:
    • Saturation line
    • Constant RH lines
    • Constant enthalpy lines
    • Constant wet-bulb temperature lines
    • Constant specific volume lines
    • Constant dry-bulb temperature lines (internal orthogonal grid, vertical)
    • Constant humidity ratio lines (internal orthogonal grid, horizontal)
  • Plot legend for each family of lines
  • Specify labels for each family of lines
  • Overlay points, zones, arrows...
  • Export SVG, PNG files

* The ranges of temperature, humidity and pressure where this library should provide good results are within the normal environments for people to live in. Don't expect right results if doing other type of thermodynamic calculations. Over saturated water vapor states are not implemented.

Usage

from psychrochart import PsychroChart

# Load default style:
chart_default = PsychroChart()
axes = chart_default.plot()
axes.get_figure()

Called from a terminal (python psychrochart), it plots and shows the default chart using the default matplotlib backend, equivalent to this python script:

from psychrochart import PsychroChart
import matplotlib.pyplot as plt

PsychroChart().plot(ax=plt.gca())
plt.show()

Chart customization

The 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. Included styles are: default, ashrae, interior and minimal.

from psychrochart import load_config, PsychroChart

# Load preconfigured styles:
chart_ashrae_style = PsychroChart('ashrae')
chart_ashrae_style.plot()

chart_minimal = PsychroChart('minimal')
chart_minimal.plot()

# Get a preconfigured style dict
dict_config = load_config('interior')

# Specify the styles JSON file:
chart_custom = PsychroChart('/path/to/json_file.json')
chart_custom.plot()

# Pass a dict with the changes wanted:
custom_style = {
    "figure": {
        "figsize": [12, 8],
        "base_fontsize": 12,
        "title": "My chart",
        "x_label": None,
        "y_label": None,
        "partial_axis": False
    },
    "limits": {
        "range_temp_c": [15, 30],
        "range_humidity_g_kg": [0, 25],
        "altitude_m": 900,
        "step_temp": .5
    },
    "saturation": {"color": [0, .3, 1.], "linewidth": 2},
    "constant_rh": {"color": [0.0, 0.498, 1.0, .7], "linewidth": 2.5,
                    "linestyle": ":"},
    "chart_params": {
        "with_constant_rh": True,
        "constant_rh_curves": [25, 50, 75],
        "constant_rh_labels": [25, 50, 75],
        "with_constant_v": False,
        "with_constant_h": False,
        "with_constant_wet_temp": False,
        "with_zones": False
    }
}

chart_custom_2 = PsychroChart(custom_style)
chart_custom_2.plot()

The custom configuration does not need to include all fields, but only the fields you want to change.

To play with it and see the results, look at this notebook with usage examples.

Tests

To run the tests, clone the repository, poetry install it, and run poetry run pytest.

License

MIT license, so do with it as you like ;-)

Included styling examples

Default style:

ASHRAE Handbook black and white style:

ASHRAE Handbook black and white style (IP units):

Minimal style:

Metadata

Release files for psychrochart 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for psychrochart 0.4.0
File Size Uploaded
psychrochart-0.4.0.tar.gz 22.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for psychrochart 0.4.0
File Interpreter ABI Platform
psychrochart-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 49.2 kB

Release files / psychrochart-0.4.0.tar.gz

Download URL psychrochart-0.4.0.tar.gz
Size 22.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a0800a559ce04ad1cc516c0fed6e119d66ca6bdfed1fa146354c64bea10f1db8
BLAKE2b-256 checksum
How to use checksums
cd588faded02720f1b61da4703e3e2e304d1a3aa27788ee7402ba7814fdee5d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.0 CPython/3.11.3 Linux/5.15.0-1038-azure

Release files / psychrochart-0.4.0-py3-none-any.whl

Download URL psychrochart-0.4.0-py3-none-any.whl
Size 26.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
471c8cd1a362b32127151714ac55a3449429de2c8c7e689ce5f90f50944b4e51
BLAKE2b-256 checksum
How to use checksums
2f03a0eadce2027ba3d8c9d5868e80b804cd6b5b4f9c03479f538776d64c2625
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.0 CPython/3.11.3 Linux/5.15.0-1038-azure

Release history Release notifications | RSS feed

0.11.1

2 release files

0.9.3

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

This release

0.4.0 This release

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

3 release files

0.1.4

2 release files

0.1.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page