Metadata-Version: 2.4
Name: scistyle
Version: 0.1.0
Summary: A custom Matplotlib styling package for scientific plots.
Project-URL: Homepage, https://github.com/Esmaeelpour/scistyle
Project-URL: Repository, https://github.com/Esmaeelpour/scistyle
Project-URL: Issues, https://github.com/Esmaeelpour/scistyle/issues
Author-email: Javad Esmaeelpour <jvd.esm@gmail.com>
License: MIT
License-File: LICENSE
Keywords: ieee,matplotlib,nature,scientific-plotting,style
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.8
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: numpy>=1.20.0
Description-Content-Type: text/markdown

# SciStyle

A custom Matplotlib styling package for scientific plots.

## Installation

```bash
pip install scistyle
```

## Usage

```python
import matplotlib.pyplot as plt
import scistyle

# List available styles
print(scistyle.list_styles())
# ['custom_style', 'ieee', 'nature', 'poster']

# Apply a specific style
scistyle.use_style('nature')

# Or combine styles (e.g., use IEEE sizing with custom colors)
# scistyle.use_style(['ieee', 'custom_style'])

# Create a plot
plt.plot([1, 2, 3], [4, 5, 6], label="Series 1")
plt.xlabel("X-axis")
plt.ylabel("Y-axis")
plt.title("Sample Plot")
plt.legend()
plt.show()
```

## Visual Gallery

<div align="center">

| Default (`custom_style`) | IEEE Journal (`ieee`) |
|:---:|:---:|
| <img src="docs/gallery/custom_style.png" width="400"> | <img src="docs/gallery/ieee.png" width="400"> |

| Nature Journal (`nature`) | Presentation Poster (`poster`) |
|:---:|:---:|
| <img src="docs/gallery/nature.png" width="400"> | <img src="docs/gallery/poster.png" width="400"> |

</div>

## Available Styles

- `custom_style`: The default serif scientific style (high DPI, LaTeX enabled).
- `ieee`: Following IEEE journal guidelines (Times New Roman, specific sizing).
- `nature`: Following Nature journal guidelines (Sans-serif, compact).
- `poster`: High-visibility style with large fonts and thick lines for presentations.

## Features

- **Journal Presets**: Ready-to-use styles for IEEE, Nature, and more.
- **Modern Packaging**: Fully installable via `pip`.
- **High Quality**: Pre-configured for publication-quality PDF and PNG exports (300 DPI).
- **Flexible**: Combine multiple styles or use them alongside standard Matplotlib styles.
- **CI/CD**: Automated testing via GitHub Actions.
