Metadata-Version: 2.4
Name: PyCaucTile
Version: 0.1.0
Summary: A package for generating tile grid maps of East Caucasian languages
Project-URL: Homepage, https://github.com/LingConLab/PyCaucTile
Author-email: Vladislava Termus <vl.trmus@gmail.com>
License-Expression: GPL-3.0
License-File: LICENSE.md
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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 :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: plotnine>=0.10.0
Description-Content-Type: text/markdown

# PyCaucTile
A package that generates tile grid maps for illustrating features of East Caucasian languages. The plots are created using `plotnine` library, providing a ggplot2-like interface in Python. 
There is an R package that shares the same functionality (see [`RCaucTile`](https://github.com/LingConLab/RCaucTile)) by George Moroz.


## Installation
```bash
pip install pycauctile
```

## Example usage
```python
from pycauctile import ec_tile_map, ec_languages

map = ec_tile_map()
map
```
![example image](examples/figures/example1.png)

```python
map = ec_tile_map(ec_languages,
            feature_column = "consonant_inventory_size",
            title = "Consonant inventory size (Moroz 2021)",
            annotate_feature = True)
map
```
![example image](examples/figures/example2.png)

## Citation