tikzplot42 0.5.4__tar.gz → 0.5.10__tar.gz

{tikzplot42-0.5.4 → tikzplot42-0.5.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.5.4
+Version: 0.5.10
 Summary: TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax.
 Author-email: Zan Ambrozic <zan.ambrozic7@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -695,6 +695,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: matplotlib
+Requires-Dist: scipy
 Dynamic: license-file
 
 # TikzPlot
@@ -713,7 +714,7 @@ Please report any bugs or unexpected behaviour in Issues. Examples may be found
 
 ## Why use this package instead of other available?
 - It is easy to use, with code being very similar to matplotlib and only minor changes are needed to switch from matplotlib to this package.
-- It relies on frontend commands, which is less likley to change in matplotlib, so new updates do not break it.
+- It relies on frontend commands, which are less likley to change in matplotlib, so new updates do not break it.
 - It generates clean and readable Tikz code, which is easy to edit and understand. Code is also efficient and does not contain unnecessary commands, which is important escpecially for large graphs.
 - If you use LLMs to generate pgfplots code, you will often get code that is not compilable, since for more complex requirements, LLMs make up commands that do not exist. This package covers many use cases and generates compilable code.
 
@@ -744,6 +745,7 @@ Some basic plot commands are already implemented with commonly used arguments:
 #### Plotting
 - `plot()`,
 - `scatter()`,
+- `quiver()`,
 - `loglog()`,
 - `semilogx()/semilogy()`,
 - `errorbar()`,
@@ -757,6 +759,18 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `step()`,
 - `imshow()`,
 - `text()`,
+- `bxp()` (without notches),
+- `boxplot()` (without notches),
+- `violin()`,
+- `violinplot()`,
+- `pie()`,
+- `pie_label()` (basic only for now),
+- `ecdf()` (empirical cumulative distribution function),
+- `magnitue_spectrum()`,
+- `phase_spectrum()`,
+- `angle_spectrum()`,
+- `specgram()`,
+- `psd()` (power spectral density),
 - `magnify()` (used to magnify part of a plot, but Tikz cannot handle `fill_between` if this one is used, which is a long known issue),
 - `axvline()/axhline()`,
 - `axvspan()/axhspan()` (background span).
@@ -789,24 +803,34 @@ If axes and plot have different name for command with same effect, both are impl
 - `ax.twinx()`,
 - `ax.set()`,
 - `ax.tick_params()`,
+- `tight_layout()` (requires local pdflatex),
+- `subplot_mosaic()` (requires TikzConfig USE_GROUPPLOTS=True),
+- `ax.inset_axes()` (requires TikzConfig USE_GROUPPLOTS=True).
 
 There is a limited support for built-in styles (e.g. `plt.style.use("default")`), you may also define your own style using `plt.style.set_profile()`. Currently supported features are: color cycle (hex colors sequence), line width (in pt), grid (with matplotlib kwargs), background (latex style key=value), additional settings (raw latex code for optional arguments to axis: key=value).
 
 #### Supported common **kwargs
+Some commonly used kwargs are listed below, check options for each command.
 - `color/c`,
 - `linestyle/ls`,
-- `linewidth/ls`,
+- `linewidth/lw`,
 - `fmt`,
 - `marker`,
 - `marksize/ms`,
 - `alpha`,
-- `label`.
+- `label`,
+- `facecolor/fc`,
+- `edgecolor/ec`,
+- `hatch`,
+- `hatch_color`,
+- `hatch_linewidth`.
 
 #### Colorbars
 Colorbars and colormaps are implemented a bit differently than in matplotlib (simplified):
 - if you use `imshow()`, you may use its return in `Colorbar()` (which you have to import as `from tikzplot import Colorbar`),
 - you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return,
 - note that only one colorbar/colormap per axis is allowed (also if you use `scatter` with colormap/colorbar).
+- `plt.colorbar()` or `fig.colorbar()` are also supported (with limited kwargs), and create instance of `Colorbar()`. 
 
 #### TikzConfig
 For plot configurations (default sizes, paddings, etc.), use `from tikzplot import TikzConfig`:

{tikzplot42-0.5.4 → tikzplot42-0.5.10}/README.md

@@ -14,7 +14,7 @@ Please report any bugs or unexpected behaviour in Issues. Examples may be found
 
 ## Why use this package instead of other available?
 - It is easy to use, with code being very similar to matplotlib and only minor changes are needed to switch from matplotlib to this package.
-- It relies on frontend commands, which is less likley to change in matplotlib, so new updates do not break it.
+- It relies on frontend commands, which are less likley to change in matplotlib, so new updates do not break it.
 - It generates clean and readable Tikz code, which is easy to edit and understand. Code is also efficient and does not contain unnecessary commands, which is important escpecially for large graphs.
 - If you use LLMs to generate pgfplots code, you will often get code that is not compilable, since for more complex requirements, LLMs make up commands that do not exist. This package covers many use cases and generates compilable code.
 
@@ -45,6 +45,7 @@ Some basic plot commands are already implemented with commonly used arguments:
 #### Plotting
 - `plot()`,
 - `scatter()`,
+- `quiver()`,
 - `loglog()`,
 - `semilogx()/semilogy()`,
 - `errorbar()`,
@@ -58,6 +59,18 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `step()`,
 - `imshow()`,
 - `text()`,
+- `bxp()` (without notches),
+- `boxplot()` (without notches),
+- `violin()`,
+- `violinplot()`,
+- `pie()`,
+- `pie_label()` (basic only for now),
+- `ecdf()` (empirical cumulative distribution function),
+- `magnitue_spectrum()`,
+- `phase_spectrum()`,
+- `angle_spectrum()`,
+- `specgram()`,
+- `psd()` (power spectral density),
 - `magnify()` (used to magnify part of a plot, but Tikz cannot handle `fill_between` if this one is used, which is a long known issue),
 - `axvline()/axhline()`,
 - `axvspan()/axhspan()` (background span).
@@ -90,24 +103,34 @@ If axes and plot have different name for command with same effect, both are impl
 - `ax.twinx()`,
 - `ax.set()`,
 - `ax.tick_params()`,
+- `tight_layout()` (requires local pdflatex),
+- `subplot_mosaic()` (requires TikzConfig USE_GROUPPLOTS=True),
+- `ax.inset_axes()` (requires TikzConfig USE_GROUPPLOTS=True).
 
 There is a limited support for built-in styles (e.g. `plt.style.use("default")`), you may also define your own style using `plt.style.set_profile()`. Currently supported features are: color cycle (hex colors sequence), line width (in pt), grid (with matplotlib kwargs), background (latex style key=value), additional settings (raw latex code for optional arguments to axis: key=value).
 
 #### Supported common **kwargs
+Some commonly used kwargs are listed below, check options for each command.
 - `color/c`,
 - `linestyle/ls`,
-- `linewidth/ls`,
+- `linewidth/lw`,
 - `fmt`,
 - `marker`,
 - `marksize/ms`,
 - `alpha`,
-- `label`.
+- `label`,
+- `facecolor/fc`,
+- `edgecolor/ec`,
+- `hatch`,
+- `hatch_color`,
+- `hatch_linewidth`.
 
 #### Colorbars
 Colorbars and colormaps are implemented a bit differently than in matplotlib (simplified):
 - if you use `imshow()`, you may use its return in `Colorbar()` (which you have to import as `from tikzplot import Colorbar`),
 - you may use `Colorbar(axis, cmap, lower, upper, ...)` for manual colorbar. Additional kwargs may also be used by `imshow()` return,
 - note that only one colorbar/colormap per axis is allowed (also if you use `scatter` with colormap/colorbar).
+- `plt.colorbar()` or `fig.colorbar()` are also supported (with limited kwargs), and create instance of `Colorbar()`. 
 
 #### TikzConfig
 For plot configurations (default sizes, paddings, etc.), use `from tikzplot import TikzConfig`:

{tikzplot42-0.5.4 → tikzplot42-0.5.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplot42"
-version = "0.5.4"
+version = "0.5.10"
 description = "TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax."
 authors = [
     { name = "Zan Ambrozic", email = "zan.ambrozic7@gmail.com" }
@@ -23,7 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.14",
     "Topic :: Scientific/Engineering :: Visualization",
 ]
-dependencies = ["numpy", "matplotlib"]
+dependencies = ["numpy", "matplotlib", "scipy"]
 
 [project.urls]
 Homepage = "https://github.com/ZanAmb/TikzPlot"