Metadata-Version: 2.1
Name: cleopatra
Version: 0.4.1
Summary: visualization package
Home-page: https://github.com/MAfarrag/cleopatra
Author: Mostafa Farrag
Author-email: moah.farag@gmail.come
License: GNU General Public License v3
Keywords: matplotlib,visualization
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: AUTHORS.rst
Requires-Dist: ffmpeg-python
Requires-Dist: hpc-utils>=0.1.3
Requires-Dist: matplotlib>=3.7.2
Requires-Dist: numpy>=1.25.2
Requires-Dist: pip>=23.2.1
Requires-Dist: pytest>=7.4.0
Requires-Dist: pytest-cov>=4.1.0

[![Python Versions](https://img.shields.io/pypi/pyversions/cleopatra.png)](https://img.shields.io/pypi/pyversions/cleopatra)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/MAfarrag/cleopatra.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MAfarrag/cleopatra/context:python)
[![Documentation Status](https://readthedocs.org/projects/cleopatra/badge/?version=latest)](https://cleopatra.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/github/Serapieum-of-alex/cleopatra/branch/main/graph/badge.svg?token=gHxH7ljIC3)](https://codecov.io/github/Serapieum-of-alex/cleopatra)

![GitHub last commit](https://img.shields.io/github/last-commit/MAfarrag/cleopatra)
![GitHub forks](https://img.shields.io/github/forks/MAfarrag/cleopatra?style=social)
![GitHub Repo stars](https://img.shields.io/github/stars/MAfarrag/cleopatra?style=social)


Current release info
====================

| Name | Downloads                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Version | Platforms |
| --- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |
| [![Conda Recipe](https://img.shields.io/badge/recipe-cleopatra-green.svg)](https://anaconda.org/conda-forge/cleopatra) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cleopatra.svg)](https://anaconda.org/conda-forge/cleopatra) [![Downloads](https://pepy.tech/badge/cleopatra)](https://pepy.tech/project/cleopatra) [![Downloads](https://pepy.tech/badge/cleopatra/month)](https://pepy.tech/project/cleopatra)  [![Downloads](https://pepy.tech/badge/cleopatra/week)](https://pepy.tech/project/cleopatra)  ![PyPI - Downloads](https://img.shields.io/pypi/dd/cleopatra?color=blue&style=flat-square) ![GitHub all releases](https://img.shields.io/github/downloads/MAfarrag/cleopatra/total) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/cleopatra.svg)](https://anaconda.org/conda-forge/cleopatra) [![PyPI version](https://badge.fury.io/py/cleopatra.svg)](https://badge.fury.io/py/cleopatra) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/cleopatra/badges/version.svg)](https://anaconda.org/conda-forge/cleopatra) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/cleopatra.svg)](https://anaconda.org/conda-forge/cleopatra) [![Join the chat at https://gitter.im/Hapi-Nile/Hapi](https://badges.gitter.im/Hapi-Nile/Hapi.svg)](https://gitter.im/Hapi-Nile/Hapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |

cleopatra - matplotlib utility package
=====================================================================
**cleopatra** is a matplotlib utility package

cleopatra


Installing cleopatra
===============

Installing `cleopatra` from the `conda-forge` channel can be achieved by:

```
conda install -c conda-forge cleopatra
```

It is possible to list all the versions of `cleopatra` available on your platform with:

```
conda search cleopatra --channel conda-forge
```

## Install from GitHub
to install the last development to time, you can install the library from GitHub
```
pip install git+https://github.com/Serapieum-of-alex/cleopatra
```

## pip
to install the last release, you can easily use pip
```
pip install cleopatra==0.4.1
```

Quick start
===========

```
  >>> import cleopatra
```

[other code samples](https://cleopatra.readthedocs.io/en/latest/?badge=latest)


=======
History
=======

0.1.0 (2022-05-24)
------------------

* First release on PyPI.

0.2.4 (2022-12-26)
------------------

* bump up numpy versions to 1.23.5, add pandas

0.2.5 (2022-12-26)
------------------

* plot array with discrete bounds takes the bounds as a parameter

0.2.6 (2023-01-31)
------------------

* bump up versions
* add serapeum_utils as a dependency

0.2.7 (2023-01-31)
------------------
* bump up numpy to version 1.24.1

0.3.0 (2023-04-11)
------------------
* change API to work completly with numpy array inputs
* chenge to conda config
* add hpc-utils to filter and access arrays
* restructure the whole modules to array, statistics, and styles modules.
* all modules has classes.
* save animation function using ffmpeg.

0.3.1 (2023-04-17)
------------------
* plot RGB plots

0.3.2 (2023-04-23)
------------------
* bump up hpc version

0.3.3 (2023-04-25)
------------------
* change the default value for the color bar label.

0.3.4 (2023-04-26)
------------------
* pass the plot kwargs to the init of the array to scale the color bar using the vmin and vmax.

0.3.5 (2023-8-31)
------------------
* Update dependencies

0.4.0 (2023-9-24)
------------------
* Add a colors module to handle issues related to
  - Converting colors from one format to another
  - Creating colormaps

0.4.1 (2024-1-11)
------------------
* add extent to the array plot.
