pyplotutil 2.0.0__py3-none-any.whl

pyplotutil-2.0.0.dist-info/METADATA

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: pyplotutil
+Version: 2.0.0
+Summary: Python utilities for academic plotting
+Project-URL: Homepage, https://github.com/hrshtst/pyplotutil
+Author-email: Hiroshi Atsuta <atsuta@ieee.org>
+Maintainer-email: Hiroshi Atsuta <atsuta@ieee.org>
+License: MIT
+License-File: LICENSE
+Keywords: matplotlib-figures,matplotlib-style-sheets,matplotlib-styles,python,scientific-papers
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Matplotlib
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: numpy>=2.2.0
+Requires-Dist: polars>=1.17.1
+Requires-Dist: scienceplots>=2.1.1
+Provides-Extra: gui
+Requires-Dist: pyqt6>=6.8.0; extra == 'gui'
+Description-Content-Type: text/markdown
+
+# pyplotutil: plotting utility for academic publications
+
+**pyplotutil** is a wrapper library of
+[polars](https://pola.rs/) and
+[matplotlib](https://matplotlib.org/), which allows you to handle time
+series data easily and create graphs tolerable to scientific
+publications.
+
+## Features
+
+- Load tabular data from CSV files, buffers, or polars frames with
+  column-attribute access (`data.time`, `data.voltage`)
+- Group rows by a tag column (`TaggedData`) or manage whole
+  directories of data files (`Dataset`)
+- Plot multiple time series and mean-with-error graphs (standard
+  deviation, standard error, variance, range)
+- Apply publication-ready matplotlib styles
+  ([SciencePlots](https://github.com/garrettj403/SciencePlots)):
+  `science`, `ieee`, `nature`, `notebook`
+- Save figures to multiple formats in one call with sanitized
+  filenames
+- Event logging helpers with file and console output
+
+## Installation
+
+Requires Python 3.11+.
+
+```console
+pip install git+https://github.com/hrshtst/pyplotutil.git
+```
+
+Interactive plotting with `plt.show()` needs a GUI backend, which is
+provided by the optional `gui` extra:
+
+```console
+pip install "pyplotutil[gui] @ git+https://github.com/hrshtst/pyplotutil.git"
+```
+
+## Quickstart
+
+```python
+import matplotlib.pyplot as plt
+
+from pyplotutil import Data, Dataset, apply_style, plot_mean_err, save_figure
+
+# Publication-ready style.
+apply_style("science", no_latex=True)
+
+# Load a single CSV file; columns are accessible as attributes.
+data = Data("experiment.csv")
+fig, ax = plt.subplots()
+ax.plot(data.t, data.position)
+
+# Load every CSV file in a directory and plot mean with standard error.
+dataset = Dataset("results/")
+t, y = dataset.get_timeseries("position")
+plot_mean_err(ax, t, y, "se", tlim=None, lw=1, capsize=2, label="mean")
+
+# Write figure.png and figure.pdf in one call.
+save_figure(fig, "output", "figure", ["png", "pdf"])
+```
+
+Group rows by a tag column:
+
+```python
+from pyplotutil import TaggedData
+
+tagged = TaggedData("trials.csv", tag_column="trial")
+for tag, data in tagged:
+    print(tag, data.param("gain"))
+```
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) and
+[nox](https://nox.thea.codes/):
+
+```console
+uv sync                 # set up the development environment
+uv run pytest           # run the test suite
+uv run mypy             # type check
+uv run ruff check       # lint
+nox                     # lint + type check + tests on Python 3.11-3.14
+```
+
+## License
+
+[MIT](LICENSE)

pyplotutil-2.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+pyplotutil/__init__.py,sha256=Lyjk-DVSqmvUQRuq5DJi3uz7lb9sJkWwIXhR5AL8J48,1624
+pyplotutil/_typing.py,sha256=i_YKJ1PrFyNzQSCB1R2UYhodO-2kahei5yvmTeXsWn8,1247
+pyplotutil/datautil.py,sha256=aQalgM4VNTajL26SmxiuCTzq2bFmK_AY9LpRq1DQIHo,39012
+pyplotutil/loggingutil.py,sha256=sS5DwhUeRK106oqIWT66KDgYYWTYlv0nIZ6AIKkTIuQ,19939
+pyplotutil/plotutil.py,sha256=WsVVobxbNTJlObPW7fC8b2eTO3S1nWEqGvXLFGUiUQ4,25655
+pyplotutil/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyplotutil-2.0.0.dist-info/METADATA,sha256=uPfubB5Tifn6rg2J0TDpjGNO0mUHPTOcSjQA_2fzHa0,3856
+pyplotutil-2.0.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+pyplotutil-2.0.0.dist-info/licenses/LICENSE,sha256=FmHEqjEFDPIJyBNdklwwLSCjxGsQSTgpsl46nDsqLsY,1071
+pyplotutil-2.0.0.dist-info/RECORD,,

pyplotutil-2.0.0.dist-info/WHEEL

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

pyplotutil-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Hiroshi Atsuta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.