Skip to content

Commit

Permalink
update the package description
Browse files Browse the repository at this point in the history
  • Loading branch information
MAfarrag committed Jul 20, 2024
1 parent 90b563e commit cac11e9
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,22 @@ Current release info

cleopatra - matplotlib utility package
=====================================================================
**cleopatra** is a 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.

cleopatra


Installing cleopatra
Expand Down

0 comments on commit cac11e9

Please sign in to comment.