fullplot 0.0.1__tar.gz

fullplot-0.0.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,90 @@
+# 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/pyproject.toml

@@ -0,0 +1,67 @@
+[project]
+name = "fullplot"
+version = "0.0.1"
+description = "A lightweight HDF5 trace plotting, filtering, and map-generation helper for engineering data."
+readme = "README.md"
+license = "GPL-3.0-only"
+authors = [
+    { name = "Saaketh Ramoju", email = "skramoju@gmail.com" }
+]
+requires-python = ">=3.11"
+keywords = [
+    "hdf5",
+    "plotting",
+    "engineering",
+    "simulation",
+    "test-data",
+    "map-generation",
+    "scientific-computing",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+dependencies = [
+    "numpy>=1.26.0",
+    "scipy>=1.11.0",
+    "h5py>=3.10.0",
+    "matplotlib>=3.8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/saakethramoju/FullPlot"
+Repository = "https://github.com/saakethramoju/FullPlot"
+Issues = "https://github.com/saakethramoju/FullPlot/issues"
+PyPI = "https://pypi.org/project/fullplot/"
+
+[project.scripts]
+fullplot = "fullplot.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.11.18,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "ruff>=0.15.20",
+]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F"]
+ignore = []
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

fullplot-0.0.1/src/fullplot/__init__.py

@@ -0,0 +1,61 @@
+"""FullPlot: lightweight HDF5 trace plotting, filtering, and map generation."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from fullplot.cli import main
+from fullplot.fullplot import (
+    AmbiguousDatasetError,
+    DatasetNotFoundError,
+    FullPlotError,
+    H5File,
+    PlotDataError,
+    Trace,
+    list,
+    map,
+    open,
+    plot,
+    read,
+    show,
+    trace,
+    tree,
+    values,
+    write_traces,
+)
+from fullplot.maps import (
+    Axis,
+    FullPlotMapError,
+    MapGenerationError,
+    MapOutputError,
+    generate_map,
+)
+
+try:
+    __version__ = version("fullplot")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "__version__",
+    "FullPlotError",
+    "DatasetNotFoundError",
+    "AmbiguousDatasetError",
+    "PlotDataError",
+    "Trace",
+    "H5File",
+    "open",
+    "tree",
+    "list",
+    "read",
+    "values",
+    "trace",
+    "plot",
+    "map",
+    "write_traces",
+    "show",
+    "Axis",
+    "FullPlotMapError",
+    "MapGenerationError",
+    "MapOutputError",
+    "generate_map",
+    "main",
+]

fullplot-0.0.1/src/fullplot/cli.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+
+from fullplot.fullplot import open as open_hdf5
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="fullplot",
+        description="Inspect HDF5 files with FullPlot.",
+    )
+    parser.add_argument(
+        "filename",
+        nargs="?",
+        type=Path,
+        help="HDF5 file to inspect.",
+    )
+    parser.add_argument(
+        "--root",
+        default="/",
+        help="HDF5 root/group to inspect. Default: /",
+    )
+    parser.add_argument(
+        "--tree",
+        action="store_true",
+        help="Print the HDF5 tree. This is the default action.",
+    )
+    parser.add_argument(
+        "--list",
+        action="store_true",
+        help="List numeric datasets under the selected root.",
+    )
+    parser.add_argument(
+        "--max-depth",
+        type=int,
+        default=None,
+        help="Maximum tree depth to print when using --tree.",
+    )
+    return parser
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    if args.filename is None:
+        parser.print_help()
+        return 0
+
+    data = open_hdf5(args.filename, root=args.root)
+
+    if args.list:
+        data.list(print_output=True)
+    else:
+        data.tree(max_depth=args.max_depth, print_output=True)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())