Metadata-Version: 2.4
Name: cmplstyle
Version: 0.6.4
Summary: A Python package providing matplotlib style for scientific plotting with traditional Chinese color palette.
Project-URL: Homepage, https://github.com/jinyiliu/cmplstyle
Project-URL: Issues, https://github.com/jinyiliu/cmplstyle/issues
Author-email: Jinyi Liu <liujy0129@gmail.com>
Maintainer-email: Jinyi Liu <liujy0129@gmail.com>
License: MIT
License-File: LICENSE
Keywords: color palette,matplotlib,scientific plotting,traditional Chinese color
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: matplotlib>=3.7.0
Description-Content-Type: text/markdown

# cmplstyle

A Python package providing matplotlib style for scientific plotting with traditional Chinese color palette.

## Installation
You can install the package using pip:
```bash
pip install cmplstyle
```

## Features

- A collection of 365 traditional Chinese colors.
- Optmised matplotlib style for scientific plotting.

## Traditional Chinese Colors (TCC)

Our color collection is sourced from the reference [《中国传统色：国民版色卡》](https://www.douban.com/doubanapp/dispatch/book/35951952?dt_dapp=1) by 郭浩, featuring hues widely used in traditional Chinese art and design. See [here](https://jinyiliu.github.io/2025/08/13/cmplstyle/TCC_ncols_5.pdf) a complete color reference.

The color names are in Chinese. Once the package is imported, the colors can be accessed by their names. For example,
```python
import cmplstyle
import seaborn
seaborn.palplot(["群青", "西子", "胭脂", "桂黄", "苍苍", "青骊", "官绿", "米汤娇", "沧浪", "梅子青", "石榴裙"])
```
will plot a color palette with the specified colors in the list:

![Example TCC Palette](./cmplstyle/assets/example_tcc_palette.png)


## LICENSE
This package is licensed under the [MIT License](./LICENSE).
