Metadata-Version: 2.1
Name: gsplot
Version: 0.1.0
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

<div align="center">
  <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)
![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;">
  <a href="https://soichiroyamane.github.io/gsplot/stable" 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.

> [!WARNING]
> This package is _beta_ quality. Expect breaking changes and many bugs 🐛. Please report any issue you encounter 🤝.

## ✨ 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/stable/demo/4_paper_plot.html)

![example](docs/_static/tutorial/SC_cal.png)

### 🌃 Example with Python REPL 🐍 and neovim 🌟

[See more details](https://soichiroyamane.github.io/gsplot/stable/guides/demo/13_REPL.html)

![repl_tutorial](./docs/_static/tutorial/repl_tutorial_sp.gif)

## 🚀 Getting Started

To use **gsplot**, ensure that you have `Python 3.10+` installed. You can install the package using `pip`:

```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.

