cleopatra


Namecleopatra JSON
Version 0.5.1 PyPI version JSON
download
home_pagehttps://github.com/MAfarrag/cleopatra
Summaryvisualization package
upload_time2024-07-23 23:08:53
maintainerNone
docs_urlNone
authorMostafa Farrag
requires_pythonNone
licenseGNU General Public License v3
keywords matplotlib visualization
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![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 Python package providing fast and flexible way to build visualize data using matplotlib. it
provides functionalities to handle 3D arrays and perform various operations on them,
such as plotting, animating, and displaying the array. it also provides functionalities for creating statistical plots,


Main Features
-------------
The `Array` class has the following functionalities:
- Initialize an array object with the provided parameters.
- Plot the array with optional parameters to customize the appearance and display cell values.
- Animate the array over time with optional parameters to customize the animation speed and display points.
- Display the array with optional parameters to customize the appearance and display point IDs.

The `Statistic` module provides a class for creating statistical plots, specifically histograms. The class, `Statistic`,
is designed to handle both 1D (single-dimensional) and 2D (multi-dimensional) data.



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

0.4.2 (2024-06-30)
------------------
* Update dependencies

0.4.3 (2024-07-13)
------------------
* Add extent to the array plot when plotting an rgb array.
* Add `ax`, and `fig` parameters to the `Array` constructor method to take an Axes and plot the array on it.
* Add `__str__` to the `Array` class.

0.5.0 (2024-07-22)
------------------

ArrayGlyph
^^^^^^^^^^
* rename the `Array` class to `ArrayGlyph`.
* add `scale_percentile` method to the `Array` class to scale the array using the percentile values.
* the `statistic.histogram` can plot multiple column array.
* change the `color_scale` values to be string (`linear`, "power", ...)
* the `kwargs` can be provided to the constructor or the `plot` method to plot the array.

Colors
^^^^^^
* rename the `get_rgb` to `to_rgb`
* add `get_type` to get the type of the color.
* add `to_hex` to convert the color to hex.
* add `to_rgb` to convert the color to rgb.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MAfarrag/cleopatra",
    "name": "cleopatra",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "matplotlib, visualization",
    "author": "Mostafa Farrag",
    "author_email": "moah.farag@gmail.come",
    "download_url": "https://files.pythonhosted.org/packages/37/d1/436a6caf303bc508852082e3388d3ed5bda75450588098c1ba7b54b5f438/cleopatra-0.5.1.tar.gz",
    "platform": null,
    "description": "[![Python Versions](https://img.shields.io/pypi/pyversions/cleopatra.png)](https://img.shields.io/pypi/pyversions/cleopatra)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![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)\n[![Documentation Status](https://readthedocs.org/projects/cleopatra/badge/?version=latest)](https://cleopatra.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/github/Serapieum-of-alex/cleopatra/branch/main/graph/badge.svg?token=gHxH7ljIC3)](https://codecov.io/github/Serapieum-of-alex/cleopatra)\n\n![GitHub last commit](https://img.shields.io/github/last-commit/MAfarrag/cleopatra)\n![GitHub forks](https://img.shields.io/github/forks/MAfarrag/cleopatra?style=social)\n![GitHub Repo stars](https://img.shields.io/github/stars/MAfarrag/cleopatra?style=social)\n\n\nCurrent release info\n====================\n\n| Name | Downloads                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Version | Platforms |\n| --- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |\n| [![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) |\n\ncleopatra - matplotlib utility package\n=====================================================================\n**cleopatra** is a Python package providing fast and flexible way to build visualize data using matplotlib. it\nprovides functionalities to handle 3D arrays and perform various operations on them,\nsuch as plotting, animating, and displaying the array. it also provides functionalities for creating statistical plots,\n\n\nMain Features\n-------------\nThe `Array` class has the following functionalities:\n- Initialize an array object with the provided parameters.\n- Plot the array with optional parameters to customize the appearance and display cell values.\n- Animate the array over time with optional parameters to customize the animation speed and display points.\n- Display the array with optional parameters to customize the appearance and display point IDs.\n\nThe `Statistic` module provides a class for creating statistical plots, specifically histograms. The class, `Statistic`,\nis designed to handle both 1D (single-dimensional) and 2D (multi-dimensional) data.\n\n\n\nInstalling cleopatra\n===============\n\nInstalling `cleopatra` from the `conda-forge` channel can be achieved by:\n\n```\nconda install -c conda-forge cleopatra\n```\n\nIt is possible to list all the versions of `cleopatra` available on your platform with:\n\n```\nconda search cleopatra --channel conda-forge\n```\n\n## Install from GitHub\nto install the last development to time, you can install the library from GitHub\n```\npip install git+https://github.com/Serapieum-of-alex/cleopatra\n```\n\n## pip\nto install the last release, you can easily use pip\n```\npip install cleopatra==0.5.1\n```\n\nQuick start\n===========\n\n```\n  >>> import cleopatra\n```\n\n[other code samples](https://cleopatra.readthedocs.io/en/latest/?badge=latest)\n\n\n=======\nHistory\n=======\n\n0.1.0 (2022-05-24)\n------------------\n\n* First release on PyPI.\n\n0.2.4 (2022-12-26)\n------------------\n\n* bump up numpy versions to 1.23.5, add pandas\n\n0.2.5 (2022-12-26)\n------------------\n\n* plot array with discrete bounds takes the bounds as a parameter\n\n0.2.6 (2023-01-31)\n------------------\n\n* bump up versions\n* add serapeum_utils as a dependency\n\n0.2.7 (2023-01-31)\n------------------\n* bump up numpy to version 1.24.1\n\n0.3.0 (2023-04-11)\n------------------\n* change API to work completly with numpy array inputs\n* chenge to conda config\n* add hpc-utils to filter and access arrays\n* restructure the whole modules to array, statistics, and styles modules.\n* all modules has classes.\n* save animation function using ffmpeg.\n\n0.3.1 (2023-04-17)\n------------------\n* plot RGB plots\n\n0.3.2 (2023-04-23)\n------------------\n* bump up hpc version\n\n0.3.3 (2023-04-25)\n------------------\n* change the default value for the color bar label.\n\n0.3.4 (2023-04-26)\n------------------\n* pass the plot kwargs to the init of the array to scale the color bar using the vmin and vmax.\n\n0.3.5 (2023-8-31)\n------------------\n* Update dependencies\n\n0.4.0 (2023-9-24)\n------------------\n* Add a colors module to handle issues related to\n  - Converting colors from one format to another\n  - Creating colormaps\n\n0.4.1 (2024-1-11)\n------------------\n* add extent to the array plot.\n\n0.4.2 (2024-06-30)\n------------------\n* Update dependencies\n\n0.4.3 (2024-07-13)\n------------------\n* Add extent to the array plot when plotting an rgb array.\n* Add `ax`, and `fig` parameters to the `Array` constructor method to take an Axes and plot the array on it.\n* Add `__str__` to the `Array` class.\n\n0.5.0 (2024-07-22)\n------------------\n\nArrayGlyph\n^^^^^^^^^^\n* rename the `Array` class to `ArrayGlyph`.\n* add `scale_percentile` method to the `Array` class to scale the array using the percentile values.\n* the `statistic.histogram` can plot multiple column array.\n* change the `color_scale` values to be string (`linear`, \"power\", ...)\n* the `kwargs` can be provided to the constructor or the `plot` method to plot the array.\n\nColors\n^^^^^^\n* rename the `get_rgb` to `to_rgb`\n* add `get_type` to get the type of the color.\n* add `to_hex` to convert the color to hex.\n* add `to_rgb` to convert the color to rgb.\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3",
    "summary": "visualization package",
    "version": "0.5.1",
    "project_urls": {
        "Homepage": "https://github.com/MAfarrag/cleopatra"
    },
    "split_keywords": [
        "matplotlib",
        " visualization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d4d500c731b8bb24fd1c35ebcd0ed9d371b5bd052182a0bf9787c0ca5809934",
                "md5": "b6ac58a14639f4f18e3d996b5994a30f",
                "sha256": "624c47f7d95194657a4e02a49d1d3b208ccbf11db733d3717cb3eded7d097782"
            },
            "downloads": -1,
            "filename": "cleopatra-0.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6ac58a14639f4f18e3d996b5994a30f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 34959,
            "upload_time": "2024-07-23T23:08:51",
            "upload_time_iso_8601": "2024-07-23T23:08:51.657246Z",
            "url": "https://files.pythonhosted.org/packages/4d/4d/500c731b8bb24fd1c35ebcd0ed9d371b5bd052182a0bf9787c0ca5809934/cleopatra-0.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37d1436a6caf303bc508852082e3388d3ed5bda75450588098c1ba7b54b5f438",
                "md5": "8822e08f1cdb6f00bd136defdd28dcd6",
                "sha256": "b4d6885f5841839510589b6efe260a429e68ce09655137b62b821a181af50c63"
            },
            "downloads": -1,
            "filename": "cleopatra-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8822e08f1cdb6f00bd136defdd28dcd6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 38511,
            "upload_time": "2024-07-23T23:08:53",
            "upload_time_iso_8601": "2024-07-23T23:08:53.633359Z",
            "url": "https://files.pythonhosted.org/packages/37/d1/436a6caf303bc508852082e3388d3ed5bda75450588098c1ba7b54b5f438/cleopatra-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-23 23:08:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MAfarrag",
    "github_project": "cleopatra",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "cleopatra"
}
        
Elapsed time: 0.55372s