fullplot 0.0.1__py3-none-any.whl

fullplot/themes.py

@@ -0,0 +1,176 @@
+from __future__ import annotations
+
+
+DARK_COLORS = [
+    "#00ff00",  # green
+    "#ff0000",  # red
+    "#ffff00",  # yellow
+    "#00ffff",  # cyan
+    "#ff00ff",  # magenta
+    "#ff9900",  # orange
+    "#ffffff",  # white
+    "#3399ff",  # blue
+    "#ff66cc",  # pink
+    "#99ff00",  # lime
+]
+
+LIGHT_COLORS = [
+    "#b00000",  # dark red
+    "#0047ab",  # stronger blue
+    "#007a33",  # darker green
+    "#a020a0",  # purple / magenta
+    "#c46a00",  # burnt orange
+    "#007a7a",  # teal
+    "#5a3dbb",  # violet-blue
+    "#000000",  # black
+    "#8a6a00",  # olive-gold
+    "#444444",  # dark gray
+]
+
+
+def check_theme(theme: str) -> str:
+    theme = str(theme).lower().strip()
+
+    if theme not in ("dark", "light"):
+        raise ValueError("theme must be either 'dark' or 'light'.")
+
+    return theme
+
+
+def theme_colors(theme: str):
+    theme = check_theme(theme)
+
+    if theme == "dark":
+        return DARK_COLORS
+
+    return LIGHT_COLORS
+
+
+def theme_settings(theme: str):
+    theme = check_theme(theme)
+
+    if theme == "dark":
+        return {
+            "figure_facecolor": "#000000",
+            "axes_facecolor": "#000000",
+            "text_color": "#ffffff",
+            "spine_color": "#ffffff",
+            "grid_color": "#8a8a8a",
+            "legend_facecolor": "#000000",
+            "legend_edgecolor": "#ffffff",
+            "axis_color": "#ffffff",
+            "line_width": 1.7,
+            "spine_width": 1.0,
+            "grid_linestyle": "--",
+            "grid_linewidth": 0.7,
+            "grid_alpha": 0.85,
+            "font_family": "monospace",
+            "label_weight": "bold",
+            "map_cmap": "plasma",
+        }
+
+    return {
+        "figure_facecolor": "#f7f7f2",
+        "axes_facecolor": "#f7f7f2",
+        "text_color": "#000000",
+        "spine_color": "#000000",
+        "grid_color": "#000000",
+        "legend_facecolor": "#f7f7f2",
+        "legend_edgecolor": "#000000",
+        "axis_color": "#000000",
+        "line_width": 1.7,
+        "spine_width": 1.0,
+        "grid_linestyle": "--",
+        "grid_linewidth": 0.7,
+        "grid_alpha": 0.60,
+        "font_family": "monospace",
+        "label_weight": "bold",
+        "map_cmap": "viridis",
+    }
+
+
+def apply_theme(fig, axes, theme: str):
+    settings = theme_settings(theme)
+    colors = theme_colors(theme)
+
+    if not isinstance(axes, (list, tuple)):
+        axes = [axes]
+
+    fig.patch.set_facecolor(settings["figure_facecolor"])
+
+    for ax in axes:
+        if ax is None:
+            continue
+
+        ax.set_facecolor(settings["axes_facecolor"])
+        ax.set_prop_cycle(color=colors)
+
+        ax.tick_params(
+            axis="both",
+            colors=settings["axis_color"],
+            direction="in",
+            length=5,
+            width=1.0,
+        )
+
+        ax.xaxis.label.set_color(settings["axis_color"])
+        ax.yaxis.label.set_color(settings["axis_color"])
+        ax.title.set_color(settings["text_color"])
+
+        ax.xaxis.label.set_fontfamily(settings["font_family"])
+        ax.yaxis.label.set_fontfamily(settings["font_family"])
+        ax.title.set_fontfamily(settings["font_family"])
+
+        ax.xaxis.label.set_fontweight(settings["label_weight"])
+        ax.yaxis.label.set_fontweight(settings["label_weight"])
+        ax.title.set_fontweight(settings["label_weight"])
+
+        for spine in ax.spines.values():
+            spine.set_color(settings["spine_color"])
+            spine.set_linewidth(settings["spine_width"])
+
+
+def grid_kwargs(theme: str):
+    settings = theme_settings(theme)
+
+    return {
+        "color": settings["grid_color"],
+        "linestyle": settings["grid_linestyle"],
+        "linewidth": settings["grid_linewidth"],
+        "alpha": settings["grid_alpha"],
+    }
+
+
+def style_legend(legend, theme: str):
+    if legend is None:
+        return
+
+    settings = theme_settings(theme)
+
+    frame = legend.get_frame()
+    frame.set_facecolor(settings["legend_facecolor"])
+    frame.set_edgecolor(settings["legend_edgecolor"])
+    frame.set_alpha(1.0)
+
+    for text in legend.get_texts():
+        text.set_color(settings["text_color"])
+        text.set_fontfamily(settings["font_family"])
+
+
+def style_colorbar(colorbar, theme: str):
+    settings = theme_settings(theme)
+
+    colorbar.ax.yaxis.label.set_color(settings["text_color"])
+    colorbar.ax.yaxis.label.set_fontfamily(settings["font_family"])
+    colorbar.ax.yaxis.label.set_fontweight(settings["label_weight"])
+
+    colorbar.ax.tick_params(
+        colors=settings["axis_color"],
+        direction="in",
+        length=5,
+        width=1.0,
+    )
+
+    for spine in colorbar.ax.spines.values():
+        spine.set_color(settings["spine_color"])
+        spine.set_linewidth(settings["spine_width"])

fullplot-0.0.1.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: fullplot
+Version: 0.0.1
+Summary: A lightweight HDF5 trace plotting, filtering, and map-generation helper for engineering data.
+Keywords: hdf5,plotting,engineering,simulation,test-data,map-generation,scientific-computing
+Author: Saaketh Ramoju
+Author-email: Saaketh Ramoju <skramoju@gmail.com>
+License-Expression: GPL-3.0-only
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: h5py>=3.10.0
+Requires-Dist: matplotlib>=3.8.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/saakethramoju/FullPlot
+Project-URL: Repository, https://github.com/saakethramoju/FullPlot
+Project-URL: Issues, https://github.com/saakethramoju/FullPlot/issues
+Project-URL: PyPI, https://pypi.org/project/fullplot/
+Description-Content-Type: text/markdown
+
+# FullPlot
+
+FullPlot is a lightweight HDF5 plotting, trace filtering, and map-generation package for engineering simulation and test data.
+
+FullPlot is intentionally independent from FullFlow. FullPlot does not import FullFlow, and FullFlow does not import FullPlot. HDF5 files are the interface between the two packages.
+
+## Installation
+
+```bash
+pip install fullplot
+```
+
+For local development with `uv`:
+
+```bash
+uv sync --dev
+uv run pytest
+```
+
+## Quick plotting
+
+```python
+import fullplot as fplt
+
+run = fplt.open("engine_sim.h5")
+run.tree()
+run.list()
+
+run.plot(
+    x="time",
+    y="node_pressure",
+    xlabel="Time [s]",
+    ylabel="Pressure [Pa]",
+)
+```
+
+## Traces
+
+A `Trace` is a generic one-dimensional line of data. It can represent simulation data, test data, a filtered trace, a redline, a blueline, a command trace, or a derived trace.
+
+```python
+import fullplot as fplt
+
+run = fplt.open("hotfire.h5")
+
+chpt = run.trace("CHPT", x="time")
+chpt_filtered = chpt.filter("moving_average", window=0.05)
+redline = fplt.Trace.constant("CHPT Redline", x=chpt.x, y=400.0, role="redline")
+
+fplt.plot([chpt, chpt_filtered, redline])
+```
+
+## Generated traces
+
+```python
+import numpy as np
+import fullplot as fplt
+
+time = np.linspace(0.0, 10.0, 1001)
+
+command = fplt.Trace.from_points(
+    "Main Ox Valve Command",
+    points=[(0.0, 0.0), (1.0, 0.0), (1.1, 1.0), (8.0, 1.0), (8.1, 0.0)],
+    x=time,
+    mode="previous",
+    role="command",
+)
+
+fplt.plot(command)
+```
+
+## Map generation
+
+FullPlot can generate rectangular HDF5 maps that another package, including FullFlow, can consume later.
+
+```python
+import fullplot as fplt
+
+fplt.generate_map(
+    "demo_map.h5",
+    group="properties",
+    axes=[
+        fplt.Axis.linear("pressure", 1.0e5, 5.0e5, 5),
+        fplt.Axis.linear("temperature", 250.0, 500.0, 6),
+    ],
+    evaluate=lambda pressure, temperature: {
+        "density": pressure / (287.0 * temperature),
+    },
+)
+```

fullplot-0.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+fullplot/__init__.py,sha256=rZ_u84Ch70gReH4G3fZr2iVn0mjGs7LVkh4cFMu-g-Q,1060
+fullplot/cli.py,sha256=XXoBT8kDIp7l3TG7ZQ5dYmHzNY4u-lc-5KsEu4o38d0,1455
+fullplot/fullplot.py,sha256=Cp1K6N2T0HflyJAODvq22CI5XhkaE_D2nixMWWOdkDM,50206
+fullplot/hdf5.py,sha256=NGb_sHHz2X5QuspiJlmyMBbZn135kUNiR1qWRkbCw-o,1345
+fullplot/maps.py,sha256=9n-Q_y05VVljxFjx1ucMIeSSpHxsFQm7G_ETsT5YO3M,24156
+fullplot/themes.py,sha256=CqiJLvYQ4M5ZRl-NmHr7lYrAsnrqWSsL3hK9xtcy200,4723
+fullplot-0.0.1.dist-info/WHEEL,sha256=uOqnPWqgFlbov4NeTCercq7cBQ2UN7xh5fiW55lOnAg,81
+fullplot-0.0.1.dist-info/entry_points.txt,sha256=4jALe-r2n_VzCxE1P4AsajIpUdkPq56IZWWOlZqPrq8,48
+fullplot-0.0.1.dist-info/METADATA,sha256=VVsLBQPQL6o5RB5Mvzkse5gnaE587Uw7S9QeQhNpIkE,3216
+fullplot-0.0.1.dist-info/RECORD,,

fullplot-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.26
+Root-Is-Purelib: true
+Tag: py3-none-any

fullplot-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+fullplot = fullplot.cli:main
+