gsplot 0.0.3__tar.gz → 0.0.4__tar.gz

{gsplot-0.0.3 → gsplot-0.0.4}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Soichiro Yamane
+Copyright (c) 2024 Giordano Mattoni and Soichiro Yamane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{gsplot-0.0.3 → gsplot-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gsplot
-Version: 0.0.3
+Version: 0.0.4
 Summary: General-scientific plot based on matplotlib
 Author: Giordano Mattoni
 Author-email: mattoni@scphys.kyoto-u.ac.jp
@@ -18,15 +18,17 @@ Requires-Dist: types-pyyaml (>=6.0.12.20240917,<7.0.0.0)
 Project-URL: Homepage, https://soichiroyamane.github.io/gsplot/
 Description-Content-Type: text/markdown
 
-# gsplot 📈
-
 <div align="center">
-  <img src="docs/_static/logo_gsplot.svg" alt="logo_gsplot" width="100">
+  <img src="docs/_static/logo/logo_title_gsplot.png" alt="logo_gsplot" width="300">
 </div>
 
 [![GitHub Page](https://github.com/SoichiroYamane/gsplot/actions/workflows/gh-pages-sphinx.yml/badge.svg)](https://github.com/SoichiroYamane/gsplot/actions/workflows/gh-pages-sphinx.yml)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/:packageName)
+![Using Poetry](https://img.shields.io/badge/Using-Poetry-blue)
+![PyPI](https://img.shields.io/pypi/v/gsplot)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/gsplot)
 ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+![License: MIT](https://img.shields.io/badge/License-MIT-green)
+
 ----------------
 
 <p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
@@ -37,46 +39,41 @@ Description-Content-Type: text/markdown
 
 Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance the capabilities of data visualization based on [matplotlib](https://matplotlib.org). This package is specifically tailored for creating high-quality figures aimed at the scientific field.
 
-## Features ✨
+## ✨ Features
 
-- **Better Plot, Less Code**: Simplify the process of creating high-quality figures 💤
+- **Better Plot, Less Code**: Simplify the process of creating high-quality figures ⚛️
 - **Compatibility**: Compatible with [matplotlib](https://matplotlib.org) 📊
 - **Customization**: Customize your configuration to fit your needs 🎨
 - **Reproducibility**: Save your package status to make plots reproducible 📦
 
-### Example using gsplot 📈
+### 📈 Example using gsplot
 
 [See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
 
-![example](demo/4_paper_plot/SC_cal.png)
+![example](docs/_static/tutorial/SC_cal.png)
 
-### Example with Python REPL 🐍 and neovim 🌟
+### 🌃 Example with Python REPL 🐍 and neovim 🌟
 
 [See more details](https://soichiroyamane.github.io/gsplot/guides/demo/13_REPL.html)
-![repl_tutorial](./docs/_static/repl_tutorial_sp.gif)
 
-## Getting Started 🚀
+![repl_tutorial](./docs/_static/tutorial/repl_tutorial_sp.gif)
 
-### Installation
+## 🚀 Getting Started
 
 To use **gsplot**, ensure that you have `Python 3.10+` installed. You can install the package using `pip`:
 
-#### important
-
-**⚠️ This package has not been published yet**
-
 ```bash
 pip install gsplot
 ```
 
-## Authors 👥
+## 👥 Authors
 
 This repository was forked from codes developed by Giordano Mattoni.
 
 - Giordano Mattoni
 - Soichiro Yamane
 
-## License 📜
+## 📜 License
 
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
 

{gsplot-0.0.3 → gsplot-0.0.4}/README.md

@@ -1,12 +1,14 @@
-# gsplot 📈
-
 <div align="center">
-  <img src="docs/_static/logo_gsplot.svg" alt="logo_gsplot" width="100">
+  <img src="docs/_static/logo/logo_title_gsplot.png" alt="logo_gsplot" width="300">
 </div>
 
 [![GitHub Page](https://github.com/SoichiroYamane/gsplot/actions/workflows/gh-pages-sphinx.yml/badge.svg)](https://github.com/SoichiroYamane/gsplot/actions/workflows/gh-pages-sphinx.yml)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/:packageName)
+![Using Poetry](https://img.shields.io/badge/Using-Poetry-blue)
+![PyPI](https://img.shields.io/pypi/v/gsplot)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/gsplot)
 ![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+![License: MIT](https://img.shields.io/badge/License-MIT-green)
+
 ----------------
 
 <p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
@@ -17,45 +19,40 @@
 
 Welcome to **gsplot** (general-scientific plot), a toolkit designed to enhance the capabilities of data visualization based on [matplotlib](https://matplotlib.org). This package is specifically tailored for creating high-quality figures aimed at the scientific field.
 
-## Features ✨
+## ✨ Features
 
-- **Better Plot, Less Code**: Simplify the process of creating high-quality figures 💤
+- **Better Plot, Less Code**: Simplify the process of creating high-quality figures ⚛️
 - **Compatibility**: Compatible with [matplotlib](https://matplotlib.org) 📊
 - **Customization**: Customize your configuration to fit your needs 🎨
 - **Reproducibility**: Save your package status to make plots reproducible 📦
 
-### Example using gsplot 📈
+### 📈 Example using gsplot
 
 [See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
 
-![example](demo/4_paper_plot/SC_cal.png)
+![example](docs/_static/tutorial/SC_cal.png)
 
-### Example with Python REPL 🐍 and neovim 🌟
+### 🌃 Example with Python REPL 🐍 and neovim 🌟
 
 [See more details](https://soichiroyamane.github.io/gsplot/guides/demo/13_REPL.html)
-![repl_tutorial](./docs/_static/repl_tutorial_sp.gif)
 
-## Getting Started 🚀
+![repl_tutorial](./docs/_static/tutorial/repl_tutorial_sp.gif)
 
-### Installation
+## 🚀 Getting Started
 
 To use **gsplot**, ensure that you have `Python 3.10+` installed. You can install the package using `pip`:
 
-#### important
-
-**⚠️ This package has not been published yet**
-
 ```bash
 pip install gsplot
 ```
 
-## Authors 👥
+## 👥 Authors
 
 This repository was forked from codes developed by Giordano Mattoni.
 
 - Giordano Mattoni
 - Soichiro Yamane
 
-## License 📜
+## 📜 License
 
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

{gsplot-0.0.3 → gsplot-0.0.4}/gsplot/figure/axes.py

@@ -171,7 +171,7 @@ class AxesHandler(Generic[_T]):
         Indicates whether shared storage is used.
     size : list of int or float
         The size of the figure in the specified unit.
-    unit : Literal["mm", "cm", "in", "pt"]
+    unit : {"mm", "cm", "in", "pt"}
         The unit for the figure size.
     mosaic : str or list of HashableList[_T] or list of HashableList[Hashable]
         The mosaic layout for subplots.
@@ -312,7 +312,7 @@ def axes(
         Whether to use a shared storage for axes or figure states (default is False).
     size : list of int or float, optional
         The size of the figure in the specified unit (default is [5, 5]).
-    unit : Literal["mm", "cm", "in", "pt"], optional
+    unit : {"mm", "cm", "in", "pt"}, optional
         The unit for the figure size. Supported units are "mm", "cm", "in", and "pt" (default is "in").
     mosaic : str or list of HashableList[_T] or list of HashableList[Hashable], optional
         The mosaic layout for subplots. Can be a string or a list of hashable items (default is "A").

{gsplot-0.0.3 → gsplot-0.0.4}/gsplot/figure/axes_base.py

@@ -105,10 +105,14 @@ class AxesResolver:
             except IndexError:
                 error_message = f"Axes out of range: {self._axis_index} => Number of axes: {len(axes)}, but requested {ordinal_suffix(self._axis_index + 1)} axis."
                 raise IndexError(error_message)
-
         elif isinstance(self.axis_target, Axes):
             self._axis = self.axis_target
-            self._axis_index = plt.gcf().axes.index(self._axis)
+            if self.axis_target in plt.gcf().axes:
+                self._axis_index = plt.gcf().axes.index(self._axis)
+            else:
+                # Add the axis to the current figure if it is not present
+                plt.gcf().add_axes(self._axis)
+                self._axis_index = len(plt.gcf().axes) - 1
         else:
             raise ValueError(
                 "Invalid axis target. Please provide an integer or Axes object."

{gsplot-0.0.3 → gsplot-0.0.4}/gsplot/style/label.py

@@ -1,3 +1,4 @@
+import warnings
 from functools import wraps
 from typing import Any, Callable, Literal, TypeVar, cast
 
@@ -778,12 +779,16 @@ class Label:
     def apply_tight_layout(self) -> None:
 
         if self.tight_layout:
-            try:
-                plt.tight_layout(
-                    w_pad=self.x_pad, h_pad=self.y_pad, *self.args, **self.kwargs
-                )
-            except Exception:
-                plt.tight_layout(w_pad=self.x_pad, h_pad=self.y_pad)
+            # Ignore this warning when using inset_axes:
+            # UserWarning: This figure includes Axes that are not compatible with tight_layout, so results might be incorrect
+            with warnings.catch_warnings():
+                warnings.simplefilter("ignore")
+                try:
+                    plt.tight_layout(
+                        w_pad=self.x_pad, h_pad=self.y_pad, *self.args, **self.kwargs
+                    )
+                except Exception:
+                    plt.tight_layout(w_pad=self.x_pad, h_pad=self.y_pad)
 
     def label(self) -> None:
 

{gsplot-0.0.3 → gsplot-0.0.4}/gsplot/style/ticks.py

@@ -47,13 +47,13 @@ class MinorTicks:
         self.axis_index: int = _axes_resolver.axis_index
         self.axis: Axes = _axes_resolver.axis
 
-    def set_minor_ticks_off(self, mode=Literal["x", "y", "xy"]) -> None:
+    def set_minor_ticks_off(self, mode: Literal["x", "y", "xy"] = "xy") -> None:
         """
         Turn off minor ticks for the specified axis.
 
         Parameters
         --------------------
-        mode : Literal["x", "y", "xy"], optional
+        mode : {"x", "y", "xy"}, optional
             Specifies the axis to configure. 'x' for x-axis, 'y' for y-axis,
             and 'xy' for both axes. Default is 'xy'.
         """
@@ -67,13 +67,13 @@ class MinorTicks:
         else:
             raise ValueError("Invalid mode. Choose from 'x', 'y', or 'xy'.")
 
-    def set_minor_ticks_on(self, mode=Literal["x", "y", "xy"]) -> None:
+    def set_minor_ticks_on(self, mode: Literal["x", "y", "xy"] = "xy") -> None:
         """
         Turn on minor ticks for the specified axis.
 
         Parameters
         --------------------
-        mode : Literal["x", "y", "xy"], optional
+        mode : {"x", "y", "xy"}, optional
             Specifies the axis to configure. 'x' for x-axis, 'y' for y-axis,
             and 'xy' for both axes. Default is 'xy'.
         """
@@ -112,7 +112,7 @@ class MinorTicksAxes:
             axis.yaxis.set_minor_locator(plticker.AutoMinorLocator())
 
 
-def ticks_off(axis_target: int | Axes, mode=Literal["x", "y", "xy"]) -> None:
+def ticks_off(axis_target: int | Axes, mode: Literal["x", "y", "xy"] = "xy") -> None:
     """
     Turn off minor ticks for the specified axis.
 
@@ -120,7 +120,7 @@ def ticks_off(axis_target: int | Axes, mode=Literal["x", "y", "xy"]) -> None:
     --------------------
     axis_target : int | Axes
         The target axis for minor tick configuration.
-    mode : Literal["x", "y", "xy"], optional
+    mode : {"x", "y", "xy"}, optional
         Specifies the axis to configure. 'x' for x-axis, 'y' for y-axis,
         and 'xy' for both axes. Default is 'xy'.
 
@@ -133,7 +133,7 @@ def ticks_off(axis_target: int | Axes, mode=Literal["x", "y", "xy"]) -> None:
     MinorTicks(axis_target).set_minor_ticks_off(mode)
 
 
-def ticks_on(axis_target: int | Axes, mode=Literal["x", "y", "xy"]) -> None:
+def ticks_on(axis_target: int | Axes, mode: Literal["x", "y", "xy"] = "xy") -> None:
     """
     Turn on minor ticks for the specified axis.
 
@@ -141,7 +141,7 @@ def ticks_on(axis_target: int | Axes, mode=Literal["x", "y", "xy"]) -> None:
     --------------------
     axis_target : int | Axes
         The target axis for minor tick configuration.
-    mode : Literal["x", "y", "xy"], optional
+    mode : {"x", "y", "xy"}, optional
         Specifies the axis to configure. 'x' for x-axis, 'y' for y-axis,
         and 'xy' for both axes. Default is 'xy'.
 

gsplot-0.0.4/gsplot/version.py

@@ -0,0 +1,2 @@
+__version__ = '0.0.4'
+__commit__ = 'b4abb098ff682226095e5a00ef7c66de4e55b589'

{gsplot-0.0.3 → gsplot-0.0.4}/pyproject.toml

@@ -1,6 +1,8 @@
 [tool.poetry]
 name = "gsplot"
-version = "0.0.3"
+
+version = "0.0.4"
+
 description = "General-scientific plot based on matplotlib"
 authors = [
   "Giordano Mattoni <mattoni@scphys.kyoto-u.ac.jp>",
@@ -39,6 +41,7 @@ sphinxcontrib-mermaid = "^1.0.0"
 pydata-sphinx-theme = "^0.16.0"
 sphinx-copybutton = "^0.5.2"
 sphinx-autobuild = "^2024.10.3"
+sphinx-multiversion = "^0.2.4"
 
 
 [build-system]

gsplot-0.0.3/gsplot/version.py

@@ -1,2 +0,0 @@
-__version__ = "0.0.1"
-__commit__ = "e177e4ac05a803b519d30cdb803d87fefaa5dcac"