fast-fig 0.8.4__tar.gz

fast_fig-0.8.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fabian Stutzki
+
+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.

fast_fig-0.8.4/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: fast_fig
+Version: 0.8.4
+Summary: FaSt_Fig is a wrapper for matplotlib with templates.
+Author-email: Fabian Stutzki <fast@fast-apps.de>
+License-Expression: MIT
+Project-URL: Homepage, https://www.fast-apps.de
+Project-URL: Repository, https://codeberg.org/FaSt-Apps/FaSt_Fig
+Project-URL: Issues, https://codeberg.org/FaSt-Apps/FaSt_Fig/issues
+Project-URL: Changelog, https://codeberg.org/FaSt-Apps/FaSt_Fig/src/branch/main/CHANGELOG.md
+Keywords: matplotlib,figure
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: matplotlib>=3.6.0
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: pyyaml>=6.0.2
+Dynamic: license-file
+
+# FaSt_Fig
+FaSt_Fig is a wrapper for matplotlib that provides a simple interface for fast and easy plotting.
+
+Key features:
+- Predefined templates for consistent styling
+- Figure instantiation in a class object
+- Simplified plotting methods with smart defaults
+- Automatic handling of DataFrames
+- Context manager support for clean resource management
+- Type hints and logging for better development experience
+
+## Installation
+
+```bash
+pip install fast_fig
+```
+
+## Basic Usage
+
+```python
+from fast_fig import FFig
+
+x = [1, 2, 3, 4, 5]
+y1 = [2, 4, 5, 6, 10]
+y2 = [1, 3, 2, 6, 9]
+
+# Simple plot example
+fig = FFig()
+fig.plot(x, y1)
+fig.show()
+
+# Use large template and save figure to multiple formats
+fig = FFig("l")
+fig.plot(x, y)
+fig.save("plot.png", "pdf")
+```
+
+## Context Manager
+
+FaSt_Fig can be used as a context manager for automatic resource cleanup:
+
+```python
+with FFig("l", nrows=2, sharex=True) as fig:  # Large template, 2 rows sharing x-axis
+    fig.plot([1, 2, 2.5], label="First")  # Plot in first axis/subplot
+    fig.set_title("First plot")
+    fig.next_axis()  # Switch to second axis/subplot
+    fig.plot([0, 1, 2], [0, 1, 4], label="Second")  # Plot with x,y data
+    fig.legend()  # Add legend
+    fig.grid()  # Add grid
+    fig.set_xlabel("X values")  # Label x-axis
+    fig.save("plot.png", "pdf")  # Save as PNG and PDF
+    # Figure automatically closed when exiting the with block
+```
+
+## Plot Types
+
+FaSt_Fig supports all plots of matplotlib.
+The following plots have adjusted settings to improve their use.
+
+```python
+# Bar plots
+fig.bar_plot(x, height)
+
+# Logarithmic scales
+fig.semilogx(x, y)  # logarithmic x-axis
+fig.semilogy(x, y)  # logarithmic y-axis
+
+# 2D plots
+x, y = np.meshgrid(np.linspace(-2, 2, 100), np.linspace(-2, 2, 100))
+z = np.exp(-(x**2 + y**2))
+
+fig.pcolor(z)  # pseudocolor plot
+fig.colorbar(label="Values")  # add colorbar
+
+
+fig.pcolor_log(z)  # pseudocolor with logarithmic color scale
+
+fig.contour(z, levels=[0.2, 0.5, 0.8])  # contour plot
+
+# Scatter plots
+fig.scatter(x, y, c=colors, s=sizes)  # scatter plot with colors and sizes
+```
+
+## DataFrame Support
+
+FaSt_Fig has built-in support for pandas DataFrames:
+
+```python
+import pandas as pd
+
+# Create a DataFrame with datetime index
+df = pd.DataFrame(
+    {"A": [1, 2, 3, 4], "B": [2, 4, 6, 8]}, index=pd.date_range("2024-01-01", periods=4)
+)
+
+fig = FFig()
+fig.plot(df)  # Automatic handling:
+# - Each column becomes a line
+# - Column names become labels
+# - Index used as x-axis
+# - Date index sets x-label to "Date"
+```
+
+## Matplotlib interaction
+
+FaSt_Fig provides direct access to matplotlib objects through these handlers:
+
+- `fig.current_axis`: Current axes instance for active subplot
+- `fig.handle_fig`: Figure instance for figure-level operations
+- `fig.handle_plot`: Current plot instance(s)
+- `fig.handle_axis`: All axes instances for subplot access
+```python
+fig.current_axis.set_yscale("log")  # Direct matplotlib axis methods
+fig.handle_fig.tight_layout()  # Adjust layout
+fig.handle_plot[0].set_linewidth(2)  # Modify line properties
+fig.handle_axis[0].set_title("First subplot")  # Access any subplot
+```
+
+These handles provide full access to matplotlib's functionality when needed.
+
+## Presets
+
+FaSt_Fig comes with built-in presets that control figure appearance. Available preset templates:
+
+- `m` (medium): 15x10 cm, sans-serif font, good for general use
+- `s` (small): 10x8 cm, sans-serif font, suitable for small plots
+- `l` (large): 20x15 cm, sans-serif font, ideal for presentations
+- `ol` (Optics Letters): 8x6 cm, serif font, optimized for single line plots
+- `oe` (Optics Express): 12x8 cm, serif font, designed for equation plots
+- `square`: 10x10 cm, serif font, perfect for square plots
+
+Each preset defines:
+- `width`: Figure width in cm
+- `height`: Figure height in cm
+- `fontfamily`: Font family (serif or sans-serif)
+- `fontsize`: Font size in points
+- `linewidth`: Line width in points
+
+You can use presets in three ways:
+
+1. Use a built-in preset:
+```python
+fig = FFig("l")  # Use large preset
+```
+
+2. Load custom presets from a file:
+```python
+fig = FFig("m", presets="my_presets.yaml")  # YAML format
+fig = FFig("m", presets="my_presets.json")  # or JSON format
+```
+
+3. Override specific preset values:
+```python
+fig = FFig("m", width=12, fontsize=14)  # Override width and fontsize
+```
+
+The preset system also includes color sequences and line styles that cycle automatically when plotting multiple lines:
+- Default colors: blue, red, green, orange
+- Default line styles: solid (-), dashed (--), dotted (:), dash-dot (-.)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+Licensed under MIT License. See [LICENSE](LICENSE) for details.
+
+## Author
+
+Written by Fabian Stutzki (fast@fast-apps.de)
+
+For more information, visit [www.fast-apps.de](https://www.fast-apps.de)

fast_fig-0.8.4/README.md

@@ -0,0 +1,173 @@
+# FaSt_Fig
+FaSt_Fig is a wrapper for matplotlib that provides a simple interface for fast and easy plotting.
+
+Key features:
+- Predefined templates for consistent styling
+- Figure instantiation in a class object
+- Simplified plotting methods with smart defaults
+- Automatic handling of DataFrames
+- Context manager support for clean resource management
+- Type hints and logging for better development experience
+
+## Installation
+
+```bash
+pip install fast_fig
+```
+
+## Basic Usage
+
+```python
+from fast_fig import FFig
+
+x = [1, 2, 3, 4, 5]
+y1 = [2, 4, 5, 6, 10]
+y2 = [1, 3, 2, 6, 9]
+
+# Simple plot example
+fig = FFig()
+fig.plot(x, y1)
+fig.show()
+
+# Use large template and save figure to multiple formats
+fig = FFig("l")
+fig.plot(x, y)
+fig.save("plot.png", "pdf")
+```
+
+## Context Manager
+
+FaSt_Fig can be used as a context manager for automatic resource cleanup:
+
+```python
+with FFig("l", nrows=2, sharex=True) as fig:  # Large template, 2 rows sharing x-axis
+    fig.plot([1, 2, 2.5], label="First")  # Plot in first axis/subplot
+    fig.set_title("First plot")
+    fig.next_axis()  # Switch to second axis/subplot
+    fig.plot([0, 1, 2], [0, 1, 4], label="Second")  # Plot with x,y data
+    fig.legend()  # Add legend
+    fig.grid()  # Add grid
+    fig.set_xlabel("X values")  # Label x-axis
+    fig.save("plot.png", "pdf")  # Save as PNG and PDF
+    # Figure automatically closed when exiting the with block
+```
+
+## Plot Types
+
+FaSt_Fig supports all plots of matplotlib.
+The following plots have adjusted settings to improve their use.
+
+```python
+# Bar plots
+fig.bar_plot(x, height)
+
+# Logarithmic scales
+fig.semilogx(x, y)  # logarithmic x-axis
+fig.semilogy(x, y)  # logarithmic y-axis
+
+# 2D plots
+x, y = np.meshgrid(np.linspace(-2, 2, 100), np.linspace(-2, 2, 100))
+z = np.exp(-(x**2 + y**2))
+
+fig.pcolor(z)  # pseudocolor plot
+fig.colorbar(label="Values")  # add colorbar
+
+
+fig.pcolor_log(z)  # pseudocolor with logarithmic color scale
+
+fig.contour(z, levels=[0.2, 0.5, 0.8])  # contour plot
+
+# Scatter plots
+fig.scatter(x, y, c=colors, s=sizes)  # scatter plot with colors and sizes
+```
+
+## DataFrame Support
+
+FaSt_Fig has built-in support for pandas DataFrames:
+
+```python
+import pandas as pd
+
+# Create a DataFrame with datetime index
+df = pd.DataFrame(
+    {"A": [1, 2, 3, 4], "B": [2, 4, 6, 8]}, index=pd.date_range("2024-01-01", periods=4)
+)
+
+fig = FFig()
+fig.plot(df)  # Automatic handling:
+# - Each column becomes a line
+# - Column names become labels
+# - Index used as x-axis
+# - Date index sets x-label to "Date"
+```
+
+## Matplotlib interaction
+
+FaSt_Fig provides direct access to matplotlib objects through these handlers:
+
+- `fig.current_axis`: Current axes instance for active subplot
+- `fig.handle_fig`: Figure instance for figure-level operations
+- `fig.handle_plot`: Current plot instance(s)
+- `fig.handle_axis`: All axes instances for subplot access
+```python
+fig.current_axis.set_yscale("log")  # Direct matplotlib axis methods
+fig.handle_fig.tight_layout()  # Adjust layout
+fig.handle_plot[0].set_linewidth(2)  # Modify line properties
+fig.handle_axis[0].set_title("First subplot")  # Access any subplot
+```
+
+These handles provide full access to matplotlib's functionality when needed.
+
+## Presets
+
+FaSt_Fig comes with built-in presets that control figure appearance. Available preset templates:
+
+- `m` (medium): 15x10 cm, sans-serif font, good for general use
+- `s` (small): 10x8 cm, sans-serif font, suitable for small plots
+- `l` (large): 20x15 cm, sans-serif font, ideal for presentations
+- `ol` (Optics Letters): 8x6 cm, serif font, optimized for single line plots
+- `oe` (Optics Express): 12x8 cm, serif font, designed for equation plots
+- `square`: 10x10 cm, serif font, perfect for square plots
+
+Each preset defines:
+- `width`: Figure width in cm
+- `height`: Figure height in cm
+- `fontfamily`: Font family (serif or sans-serif)
+- `fontsize`: Font size in points
+- `linewidth`: Line width in points
+
+You can use presets in three ways:
+
+1. Use a built-in preset:
+```python
+fig = FFig("l")  # Use large preset
+```
+
+2. Load custom presets from a file:
+```python
+fig = FFig("m", presets="my_presets.yaml")  # YAML format
+fig = FFig("m", presets="my_presets.json")  # or JSON format
+```
+
+3. Override specific preset values:
+```python
+fig = FFig("m", width=12, fontsize=14)  # Override width and fontsize
+```
+
+The preset system also includes color sequences and line styles that cycle automatically when plotting multiple lines:
+- Default colors: blue, red, green, orange
+- Default line styles: solid (-), dashed (--), dotted (:), dash-dot (-.)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+Licensed under MIT License. See [LICENSE](LICENSE) for details.
+
+## Author
+
+Written by Fabian Stutzki (fast@fast-apps.de)
+
+For more information, visit [www.fast-apps.de](https://www.fast-apps.de)

fast_fig-0.8.4/fast_fig/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) 2023 Fabian Stutzki
+# ruff: noqa: N999
+"""Init script for fast_fig to access class FFig more easily."""
+
+from . import presets  # noqa: F401
+from .class_ffig import FFig  # noqa: F401