Skip to main content

visualization package

Project description

Cleopatra

PyPI version Python Versions Conda Version License: GPL v3 codecov

Docs pre-commit GitHub last commit GitHub Repo stars

Cleopatra is a matplotlib utility package for visualizing 2D/3D numpy arrays, unstructured meshes, and statistical histograms. It targets scientific and research users working with geospatial and raster data, providing a high-level API over matplotlib with sensible defaults and rich customization.

Main Features

ArrayGlyph -- Raster / Array Visualization

  • Plot 2D numpy arrays with automatic colorbar and customizable color scales (linear, power, symmetric log-norm, boundary-norm, midpoint).
  • Display cell values and overlay point markers on the plot.
  • Animate 3D arrays over time and export to GIF, MP4, MOV, or AVI (via ffmpeg).

Array Plot Animated Array

MeshGlyph -- Unstructured Mesh Visualization

  • Visualize UGRID-style unstructured mesh data using triangulation (tripcolor, tricontourf).
  • Render wireframe outlines via LineCollection.
  • Accepts raw numpy arrays of node coordinates and face-node connectivity.
  • Animate time-varying mesh data.

StatisticalGlyph -- Histogram Plots

  • Create histograms for 1D and 2D datasets with customizable bins, colors, and transparency.

Histogram Multi-Histogram

Colors -- Color Utilities

  • Convert between hex, RGB (0-255), and normalized RGB (0-1) formats.
  • Extract color ramps from images and create custom matplotlib colormaps.

Installation

pip

pip install cleopatra

conda

conda install -c conda-forge cleopatra

From source (latest development version)

pip install git+https://github.com/serapeum-org/cleopatra

Quick Start

Plot a 2D array

import numpy as np
from cleopatra.array_glyph import ArrayGlyph

arr = np.random.rand(10, 10)
glyph = ArrayGlyph(arr)
fig, ax = glyph.plot(title="Random Array")

Create a histogram

import numpy as np
from cleopatra.statistical_glyph import StatisticalGlyph

data = np.random.normal(0, 1, 1000)
stat = StatisticalGlyph(data)
fig, ax = stat.histogram(bins=30)

Plot an unstructured mesh

import numpy as np
from cleopatra.mesh_glyph import MeshGlyph

node_x = np.array([0.0, 1.0, 0.5, 1.5])
node_y = np.array([0.0, 0.0, 1.0, 1.0])
face_nodes = np.array([[0, 1, 2], [1, 3, 2]])
face_data = np.array([10.0, 20.0])

mg = MeshGlyph(node_x, node_y, face_nodes)
fig, ax = mg.plot(face_data, location="face", title="Mesh Data")

Requirements

  • Python >= 3.11
  • numpy >= 2.0.0
  • matplotlib >= 3.8.4

Documentation

Full documentation is available at serapeum-org.github.io/cleopatra.

License

Cleopatra is licensed under the GNU General Public License v3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cleopatra-0.7.1.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cleopatra-0.7.1-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

Details for the file cleopatra-0.7.1.tar.gz.

File metadata

  • Download URL: cleopatra-0.7.1.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for cleopatra-0.7.1.tar.gz
Algorithm Hash digest
SHA256 e089356a61daa7a06228fe6ba25006e9a6c664866707bc9ad763b845c7ecdbbc
MD5 597b2e6049b4687b3d813a86c182483a
BLAKE2b-256 63b10bd08cdbb4d49678fc942723f611c9d3eea6e82457e9d2386cefedd1ebb3

See more details on using hashes here.

File details

Details for the file cleopatra-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: cleopatra-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 56.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for cleopatra-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ddcfcca9d297a25e966fa0abf2c7f7cf8a8b31762b1c0bdb07c8f33493aaa6ea
MD5 958970e83390daa3db0f5325d9e28706
BLAKE2b-256 4e3a583d7fb95d7ddba603c1bbfc8777be163f86e59f9d624de4195c298dd4f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page