plotez 0.2.0

Mundane plotting done easy.

plotEZ

Mundane plotting made easy.

plotez is a Python library that simplifies common matplotlib plotting tasks with an intuitive API. Create complex plots with minimal boilerplate code.

Features

• Simple API: Create complex plots with just a few lines of code
• Error Bar Plotting: Comprehensive error bar support with enhanced styling options
• Error Band Plotting: Shaded error band support via plot_errorband and ErrorBandConfig
• Dual-Axis Support: Easy creation of dual y-axis or dual x-axis plots
• Multi-Panel Layouts: Flexible subplot arrangements with automatic labeling
• File Integration: Direct plotting from CSV files
• Extensive Customization: Full control over plot appearance via parameter classes
• Type Safety: Complete type hints for better IDE support and type checking (PEP 561 compliant)
• Well Tested: Comprehensive test suite with 85%+ coverage

Installation

From PyPI

pip install plotez

From Source

git clone https://github.com/syedalimohsinbukhari/plotez.git
cd plotez
pip install -e .

Development Installation

pip install -e ".[dev]"

Quick Start

"""Basic plotting example."""

import numpy as np
from plotez import plot_xy

# Generate data
x = np.linspace(0, 10, 100)
y = np.sin(x)

# Create a plot with automatic labeling
plot_xy(x, y, auto_label=True)

Examples

Dual Y-Axis Plot

"""Demonstration of dual-y axis capability."""

import numpy as np
from plotez import plot_xyy

x = np.linspace(0, 10, 100)
y1 = np.sin(x)
y2 = np.exp(-x / 10)

plot_xyy(x, y1, y2,
         x_label="Time", y1_label="Sine", y2_label="Exponential",
         data_labels=["sin(x)", "exp(-x/10)"], plot_title="Dual Y-Axis Example")

"""Demonstration of dual-y axis capability with custom plot configuration."""

import matplotlib.pyplot as plt
import numpy as np

from plotez import plot_xyy
from plotez.backend import LinePlotConfig

x = np.linspace(0, 10, 50)
y1 = np.sin(x)
y2 = np.exp(-x / 10)

plot_config = LinePlotConfig(linestyle=["--", "-."], color=["red", "cyan"], marker=["o", "s"],
                             markersize=[10, 10], markeredgecolor=["k", "k"], _extra={"markevery": [3, 5]})

plot_xyy(x, y1, y2,
         x_label="Time", y1_label="Sine", y2_label="Exponential", data_labels=["sin(x)", "exp(-x/10)"],
         plot_config=plot_config)

Multi-Panel Plots

"""Demonstration of multi-panel layout capability with customizations."""

import numpy as np
from plotez import n_plotter
from plotez.backend import LinePlotConfig, FigureConfig

# Create 2×2 grid
x_data = [np.linspace(0, 10, 100) for _ in range(6)]
y_data = [
    np.sin(x_data[0]),
    np.cos(x_data[1]),
    np.tan(x_data[2] / 5),
    x_data[3]**2 / 100,
    1 / np.cos(x_data[4]),
    x_data[5]
]

line_config = LinePlotConfig(color=["red", "blue", "green", "black", "orange", "magenta"])
fig_config = FigureConfig(figsize=(10, 6))

fig, axs = n_plotter(x_data, y_data,
                     n_rows=2, n_cols=3, auto_label=True,
                     plot_config=line_config, figure_config=fig_config)

Error Bar Plots

import numpy as np

from plotez import plot_errorbar
from plotez.backend import ErrorPlotConfig

# Generate sample data with errors
x = np.linspace(0, 10, 20)
x_err = 0.4
y = np.sin(x)
y_err = 0.1 * np.random.rand(len(y))

# Enhanced error bar styling
ep = ErrorPlotConfig(
    linestyle=':',
    linewidth=2,
    color='darkblue',
    marker='d',
    markersize=6,
    capsize=8,
    elinewidth=2,  # Error bar line width
    ecolor='red',  # Error bar color (different from line!)
    capthick=2  # Error bar cap thickness
)
plot_errorbar(x, y, x_err=x_err, y_err=y_err, errorbar_config=ep)

Error Band Plots

"""Demonstration of error band plotting with custom configurations."""
import numpy as np

from plotez import plot_errorband
from plotez.backend import ErrorBandConfig, LinePlotConfig

rng = np.random.default_rng(1234)

x = np.linspace(0, 10, 50)
y = np.sin(x)
y_low = y - 0.2
y_upp = y + 0.2

error_config = ErrorBandConfig(color="cyan", edgecolor="k", linestyle="--", hatch="\\")
line_config = LinePlotConfig(color="gold", linestyle="--", linewidth=2,
                             marker="o", markersize=5, markeredgecolor="k")

ax = plot_errorband(x, y, y_low, y_upp,
                    data_label=r"$\sin(X)$", band_config=error_config, line_config=line_config)

Development

Running Tests

pytest

With Coverage Report

pytest --cov=src/plotez --cov-report=html

Type Checking

mypy src/plotez

Building Documentation

cd docs
make html

Project Status

• Type hints are corrected throughout the codebase
• Test suite implemented (80%+ coverage)
• Documentation structure created
• Development tools configured (pytest, mypy, sphinx)
• PEP 561 compliance (py.typed marker)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License – see LICENSE file for details.

Authors

• Syed Ali Mohsin Bukhari - [e-mail]

Links

• Repository: https://github.com/syedalimohsinbukhari/plotez
• Issues: https://github.com/syedalimohsinbukhari/plotez/issues