gsplot 0.0.1__tar.gz

gsplot-0.0.1/LICENSE

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

gsplot-0.0.1/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: gsplot
+Version: 0.0.1
+Summary: General-scientific plot based on matplotlib
+Author: Giordano Mattoni
+Author-email: mattoni@scphys.kyoto-u.ac.jp
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
+Requires-Dist: numpy (>=1.26.4,<2.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: rich (>=13.9.4,<14.0.0)
+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">
+</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)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+----------------
+
+<p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
+  <a href="https://soichiroyamane.github.io/gsplot/" style="text-decoration: none;">Docs</a> |
+  <a href="#authors" style="text-decoration: none;">Authors</a> |
+  <a href="#license" style="text-decoration: none;">License</a>
+</p>
+
+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 ✨
+
+- **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 📈
+
+[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
+
+![example](demo/4_paper_plot/SC_cal.png)
+
+### 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 🚀
+
+### Installation
+
+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 👥
+
+This repository was forked from codes developed by Giordano Mattoni.
+
+- Giordano Mattoni
+- Soichiro Yamane
+
+## License 📜
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+

gsplot-0.0.1/README.md

@@ -0,0 +1,61 @@
+# gsplot 📈
+
+<div align="center">
+  <img src="docs/_static/logo_gsplot.svg" alt="logo_gsplot" width="100">
+</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)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+----------------
+
+<p align="center" style="font-weight: bold; font-size: 1.2em; margin: 20px 0;">
+  <a href="https://soichiroyamane.github.io/gsplot/" style="text-decoration: none;">Docs</a> |
+  <a href="#authors" style="text-decoration: none;">Authors</a> |
+  <a href="#license" style="text-decoration: none;">License</a>
+</p>
+
+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 ✨
+
+- **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 📈
+
+[See more details](https://soichiroyamane.github.io/gsplot/guides/demo/4_paper_plot.html)
+
+![example](demo/4_paper_plot/SC_cal.png)
+
+### 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 🚀
+
+### Installation
+
+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 👥
+
+This repository was forked from codes developed by Giordano Mattoni.
+
+- Giordano Mattoni
+- Soichiro Yamane
+
+## License 📜
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

gsplot-0.0.1/gsplot/__init__.py

@@ -0,0 +1,98 @@
+from .color.colormap import get_cmap
+from .config.config import (Config, config_dict, config_entry_option,
+                            config_load)
+from .data.load_file import load_file
+from .figure.axes import axes
+from .figure.figure_tools import get_figure_size
+from .figure.show import show
+from .hello_world.hello_world import hello_world
+from .logger import logger
+from .path.path import home, pwd, pwd_main, pwd_move
+from .plot.line import line
+from .plot.line_colormap_dashed import line_colormap_dashed
+from .plot.line_colormap_solid import line_colormap_solid
+from .plot.scatter import scatter
+from .plot.scatter_colormap import scatter_colormap
+from .style.graph import (graph_facecolor, graph_square, graph_square_axes,
+                          graph_transparent, graph_transparent_axes,
+                          graph_white, graph_white_axes)
+from .style.label import label, label_add_index
+from .style.legend import (legend, legend_axes, legend_get_handlers,
+                           legend_handlers, legend_reverse)
+from .style.legend_colormap import legend_colormap
+from .style.ticks import ticks_off, ticks_on, ticks_on_axes
+from .version import __commit__, __version__
+
+# ╭──────────────────────────────────────────────────────────╮
+# │ Load the configuration file                              │
+# ╰──────────────────────────────────────────────────────────╯
+Config()
+
+# ╭──────────────────────────────────────────────────────────╮
+# │ Logging setup                                            │
+# ╰──────────────────────────────────────────────────────────╯
+logger()
+
+
+__version__ = __version__
+__commit__ = __commit__
+
+
+__all__ = [
+    # color/colormap.py
+    "get_cmap",
+    # data/load_file.py
+    "load_file",
+    # figure/axes.py
+    "axes",
+    # figure/figure_tools.py
+    "get_figure_size",
+    # figure/show.py
+    "show",
+    # hello_world.py
+    "hello_world",
+    # config/config.py
+    "config_load",
+    "config_dict",
+    "config_entry_option",
+    # path/path.py
+    "home",
+    "pwd",
+    "pwd_move",
+    "pwd_main",
+    # plot/line.py
+    "line",
+    # plot/line_colormap.py
+    "line_colormap",
+    # plot/line_colormap_solid.py
+    "line_colormap_solid",
+    # plot/line_colormap_dashed.py
+    "line_colormap_dashed",
+    # plot/scatter.py
+    "scatter",
+    # plot/scatter_colormap.py
+    "scatter_colormap",
+    # style/graph.py
+    "graph_square",
+    "graph_square_axes",
+    "graph_white",
+    "graph_white_axes",
+    "graph_transparent",
+    "graph_transparent_axes",
+    "graph_facecolor",
+    # style/label.py
+    "label",
+    "label_add_index",
+    # style/legend.py
+    "legend",
+    "legend_axes",
+    "legend_handlers",
+    "legend_reverse",
+    "legend_get_handlers",
+    # style/legend_colormap.py
+    "legend_colormap",
+    # style/ticks.py
+    "ticks_off",
+    "ticks_on",
+    "ticks_on_axes",
+]