## Matplot3DEx Documentation
## Table of Contents
1. [Overview](#overview)
2. [Installation](#installation)
3. [Usage](#usage)
- [Example: 3D Surface Plot](#example-3d-surface-plot)
- [Example: 3D Wireframe Plot](#example-3d-wireframe-plot)
- [Example: 3D Bar Plot](#example-3d-bar-plot)
4. [Classes](#classes)
5. [Advanced Features](#advanced-features)
- [Data Science Module](#data-science-module)
- [Math Module](#math-module)
- [Add-Ons Module](#add-ons-module)
6. [More Usage](#more-usage)
- [Example: 3D Scatter Plot](#example-3d-scatter-plot-1)
- [Example: 3D Surface Plot](#example-3d-surface-plot-1)
- [Example: 2D Heatmap](#example-2d-heatmap)
- [Example: Animated 3D Scatter Plot](#example-animated-3d-scatter-plot)
- [Example: 2D Hexbin Plot](#example-2d-hexbin-plot)
- [Example: 3D Quiver Plot](#example-3d-quiver-plot)
## Overview
Matplot3DEx is an extension of Matplotlib, providing a simplified API for creating a variety of 3D and 2D plots with enhanced customization options. This package aims to facilitate the creation of visually appealing and informative plots for data analysis and visualization tasks.
## Installation
To install Matplot3DEx, use the following command:
```bash
pip install Matplot3DEx
```
## Usage
### Example: 3D Surface Plot
```python
from Matplot3DEx import Matplot3DEx
import numpy as np
# Create a meshgrid for the surface plot
x = np.linspace(-5, 5, 100)
y = np.linspace(-5, 5, 100)
x, y = np.meshgrid(x, y)
z = x**2 - y**2
# Create a 3D surface plot
surface_plot = Matplot3DEx.Surface3D(x, y, z, title='3D Surface Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
surface_plot.show()
```
### Example: 3D Wireframe Plot
```python
from Matplot3DEx import Matplot3DEx
import numpy as np
# Create a meshgrid for the wireframe plot
x = np.linspace(-5, 5, 100)
y = np.linspace(-5, 5, 100)
x, y = np.meshgrid(x, y)
z = x**2 - y**2
# Create a 3D wireframe plot
wireframe_plot = Matplot3DEx.Wireframe3D(x, y, z, title='3D Wireframe Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
wireframe_plot.show()
```
### Example: 3D Bar Plot
```python
from Matplot3DEx import Matplot3DEx
# Sample data for 3D bar plot
x = [1, 2, 3, 4, 5]
y = [2, 3, 4, 5, 6]
z = [3, 4, 5, 6, 7]
# Dimensions of the bars
dx = 0.8
dy = 0.8
dz = [1, 1, 1, 1, 1]
# Create a 3D bar plot
bar_plot = Matplot3DEx.Bar3D(x, y, z, dx, dy, dz, title='3D Bar Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
bar_plot.show()
```
## Classes
The Matplot3DEx package includes the following classes, each designed for specific types of plots:
| Class | Description |
|-----------------------------------|---------------------------------------------------------|
| `Matplot3DEx.BasePlot` | Base class for common plot settings (title, labels). |
| `Matplot3DEx.Base3DPlot` | Extension of `BasePlot` for 3D plots with Z-axis labels.|
| `Matplot3DEx.Scatter3D` | 3D scatter plot with customizable color and markers. |
| `Matplot3DEx.Surface3D` | 3D surface plot with adjustable colormap and transparency. |
| `Matplot3DEx.Wireframe3D` | 3D wireframe plot with customizable color and linewidth.|
| `Matplot3DEx.Bar3D` | 3D bar plot with customizable dimensions and color. |
| `Matplot3DEx.Quiver3D` | 3D quiver plot for vector visualization. |
| `Matplot3DEx.Contour3D` | 3D contour plot with adjustable colormap and levels. |
| `Matplot3DEx.Heatmap2D` | 2D heatmap plot with customizable colormap. |
| `Matplot3DEx.AnimatedScatter3D` | Animated 3D scatter plot for dynamic data visualization. |
| `Matplot3DEx.Boxplot2D` | 2D box plot with customizable appearance. |
| `Matplot3DEx.Hexbin2D` | 2D hexbin plot with options for gridsize and colormap. |
| `Matplot3DEx.TriangularMesh3D` | 3D triangular mesh plot with adjustable colormap. |
| `Matplot3DEx.Streamline3D` | 3D streamline plot for visualizing vector fields. |
| `Matplot3DEx.ColorSizeScatter2D` | 2D scatter plot with color and size coding. |
| `Matplot3DEx.GroupedBoxplot2D` | Grouped 2D box plot for comparing categories. |
| `Matplot3DEx.PairwiseScatterplotMatrix` | Pairwise scatterplot matrix for exploring relationships. |
| `Matplot3DEx.CorrelationHeatmap` | Heatmap for visualizing correlation matrices. |
| `Matplot3DEx.HistogramWithKDE` | Histogram plot with Kernel Density Estimation (KDE). |
| `Matplot3DEx.ViolinPlot` | Violin plot for visualizing distribution and density. |
| `Matplot3DEx.ParametricCurve` | 2D plot of a parametric curve. |
| `Matplot3DEx.PolarRose` | Polar plot representing a rose curve. |
| `Matplot3DEx.ParametricSurface3D` | 3D parametric surface plot. |
| `Matplot3DEx.SaddleSurface` | 3D plot of a saddle surface. |
| `Matplot3DEx.QuaternionRotation` | 3D plot of a vector rotation using quaternions. |
| `Matplot3DEx.TimeSeriesRollingAverage` | Time series plot with rolling average. |
| `Matplot3DEx.HistogramOutlierDetection` | Histogram with outlier detection. |
| `Matplot3DEx.ScatterRegressionPlot` | Scatter plot with linear regression line. |
| `Matplot3DEx.StackedAreaTimeSeries` | Stacked area plot for time series data. |
| `Matplot3DEx.ConfusionMatrixHeatmap` | Heatmap for visualizing confusion matrices. |
## Advanced Features
Matplot3DEx also provides advanced features for specific use cases:
- **Data Science Module**: Includes classes for statistical analysis and data exploration.
- **Math Module**: Incorporates mathematical plots and functions for mathematical visualizations.
- **Add-Ons Module**: Additional classes that extend the functionality of Matplot3DEx.
## More Usage
### Example: 3D Scatter Plot
```python
import numpy as np
from Matplot3DEx import Matplot3DEx
# Generate sample data
x = np.random.rand(100)
y = np.random.rand(100)
z = np.random.rand(100)
# Create a 3D scatter plot
scatter_plot = Matplot3DEx.Scatter3D(x, y, z, title='3D Scatter Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
scatter_plot.show()
```
### Example: 3D Surface Plot
```python
import numpy as np
from Matplot3DEx import Matplot3DEx
# Generate sample data
x = np.linspace(-5, 5, 100)
y = np.linspace(-5, 5, 100)
x, y = np.meshgrid(x, y)
z = x**2 - y**2
# Create a 3D surface plot
surface_plot = Matplot3DEx.Surface3D(x, y, z, title='3D Surface Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
surface_plot.show()
```
### Example: 2D Heatmap
```python
from Matplot3DEx import Matplot3DEx
import numpy as np
# Generate sample data
data = np.random.rand(10, 10)
# Create a 2D heatmap
heatmap_plot = Matplot3DEx.Heatmap2D(data, title='2D Heatmap', xlabel='X-axis', ylabel='Y-axis')
heatmap_plot.show()
```
### Example: Animated 3D Scatter Plot
```python
import numpy as np
from Matplot3DEx import Matplot3DEx
# Generate sample data
x = np.random.rand(100)
y = np.random.rand(100)
z = np.random.rand(100)
# Create an animated 3D scatter plot
animated_scatter = Matplot3DEx.AnimatedScatter3D(x, y, z, title='Animated 3D Scatter Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
animated_scatter.animate(frames=50, interval=100)
```
### Example: 2D Hexbin Plot
```python
import numpy as np
from Matplot3DEx import Matplot3DEx
# Generate sample data
x = np.random.normal(size=1000)
y = np.random.normal(size=1000)
# Create a 2D hexbin plot
hexbin_plot = Matplot3DEx.Hexbin2D(x, y, gridsize=30, cmap='viridis')
hexbin_plot.show()
```
### Example: 3D Quiver Plot
```python
import numpy as np
from Matplot3DEx import Matplot3DEx
# Generate sample data
x = np.linspace(-5, 5, 20)
y = np.linspace(-5, 5, 20)
z = np.linspace(-5, 5, 20)
x, y, z = np.meshgrid(x, y, z)
u = np.sin(x + y + z)
v = np.cos(x - y - z)
w = np.sin(2 * x)
# Create a 3D quiver plot
quiver_plot = Matplot3DEx.Quiver3D(x, y, z, u, v, w, title='3D Quiver Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')
quiver_plot.show()
```
## Contributing
If you find any issues or have suggestions for improvements, feel free to contribute! Visit the [GitHub repository](https://github.com/ishanoshada/matplot3dex) for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/ishanoshada/matplot3dex/blob/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ishanoshada/matplot3dex",
"name": "Matplot3DEx",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ishan Oshada",
"author_email": "ishan.kodithuwakku@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0a/60/196c4d72d855c64d7284b0dee1f0c45b43b52af4d24ab1e3219fb3b92242/Matplot3DEx-0.1.tar.gz",
"platform": null,
"description": "## Matplot3DEx Documentation\n\n## Table of Contents\n\n1. [Overview](#overview)\n2. [Installation](#installation)\n3. [Usage](#usage)\n - [Example: 3D Surface Plot](#example-3d-surface-plot)\n - [Example: 3D Wireframe Plot](#example-3d-wireframe-plot)\n - [Example: 3D Bar Plot](#example-3d-bar-plot)\n4. [Classes](#classes)\n5. [Advanced Features](#advanced-features)\n - [Data Science Module](#data-science-module)\n - [Math Module](#math-module)\n - [Add-Ons Module](#add-ons-module)\n6. [More Usage](#more-usage)\n - [Example: 3D Scatter Plot](#example-3d-scatter-plot-1)\n - [Example: 3D Surface Plot](#example-3d-surface-plot-1)\n - [Example: 2D Heatmap](#example-2d-heatmap)\n - [Example: Animated 3D Scatter Plot](#example-animated-3d-scatter-plot)\n - [Example: 2D Hexbin Plot](#example-2d-hexbin-plot)\n - [Example: 3D Quiver Plot](#example-3d-quiver-plot)\n\n## Overview\n\nMatplot3DEx is an extension of Matplotlib, providing a simplified API for creating a variety of 3D and 2D plots with enhanced customization options. This package aims to facilitate the creation of visually appealing and informative plots for data analysis and visualization tasks.\n\n## Installation\n\nTo install Matplot3DEx, use the following command:\n\n```bash\npip install Matplot3DEx\n```\n\n## Usage\n\n### Example: 3D Surface Plot\n\n```python\nfrom Matplot3DEx import Matplot3DEx\nimport numpy as np\n\n# Create a meshgrid for the surface plot\nx = np.linspace(-5, 5, 100)\ny = np.linspace(-5, 5, 100)\nx, y = np.meshgrid(x, y)\nz = x**2 - y**2\n\n# Create a 3D surface plot\nsurface_plot = Matplot3DEx.Surface3D(x, y, z, title='3D Surface Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nsurface_plot.show()\n```\n\n\n\n### Example: 3D Wireframe Plot\n\n```python\nfrom Matplot3DEx import Matplot3DEx\nimport numpy as np\n\n# Create a meshgrid for the wireframe plot\nx = np.linspace(-5, 5, 100)\ny = np.linspace(-5, 5, 100)\nx, y = np.meshgrid(x, y)\nz = x**2 - y**2\n\n# Create a 3D wireframe plot\nwireframe_plot = Matplot3DEx.Wireframe3D(x, y, z, title='3D Wireframe Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nwireframe_plot.show()\n```\n\n\n### Example: 3D Bar Plot\n\n```python\nfrom Matplot3DEx import Matplot3DEx\n\n# Sample data for 3D bar plot\nx = [1, 2, 3, 4, 5]\ny = [2, 3, 4, 5, 6]\nz = [3, 4, 5, 6, 7]\n\n# Dimensions of the bars\ndx = 0.8\ndy = 0.8\ndz = [1, 1, 1, 1, 1]\n\n# Create a 3D bar plot\nbar_plot = Matplot3DEx.Bar3D(x, y, z, dx, dy, dz, title='3D Bar Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nbar_plot.show()\n```\n\n\n## Classes\n\nThe Matplot3DEx package includes the following classes, each designed for specific types of plots:\n\n\n| Class | Description |\n|-----------------------------------|---------------------------------------------------------|\n| `Matplot3DEx.BasePlot` | Base class for common plot settings (title, labels). |\n| `Matplot3DEx.Base3DPlot` | Extension of `BasePlot` for 3D plots with Z-axis labels.|\n| `Matplot3DEx.Scatter3D` | 3D scatter plot with customizable color and markers. |\n| `Matplot3DEx.Surface3D` | 3D surface plot with adjustable colormap and transparency. |\n| `Matplot3DEx.Wireframe3D` | 3D wireframe plot with customizable color and linewidth.|\n| `Matplot3DEx.Bar3D` | 3D bar plot with customizable dimensions and color. |\n| `Matplot3DEx.Quiver3D` | 3D quiver plot for vector visualization. |\n| `Matplot3DEx.Contour3D` | 3D contour plot with adjustable colormap and levels. |\n| `Matplot3DEx.Heatmap2D` | 2D heatmap plot with customizable colormap. |\n| `Matplot3DEx.AnimatedScatter3D` | Animated 3D scatter plot for dynamic data visualization. |\n| `Matplot3DEx.Boxplot2D` | 2D box plot with customizable appearance. |\n| `Matplot3DEx.Hexbin2D` | 2D hexbin plot with options for gridsize and colormap. |\n| `Matplot3DEx.TriangularMesh3D` | 3D triangular mesh plot with adjustable colormap. |\n| `Matplot3DEx.Streamline3D` | 3D streamline plot for visualizing vector fields. |\n| `Matplot3DEx.ColorSizeScatter2D` | 2D scatter plot with color and size coding. |\n| `Matplot3DEx.GroupedBoxplot2D` | Grouped 2D box plot for comparing categories. |\n| `Matplot3DEx.PairwiseScatterplotMatrix` | Pairwise scatterplot matrix for exploring relationships. |\n| `Matplot3DEx.CorrelationHeatmap` | Heatmap for visualizing correlation matrices. |\n| `Matplot3DEx.HistogramWithKDE` | Histogram plot with Kernel Density Estimation (KDE). |\n| `Matplot3DEx.ViolinPlot` | Violin plot for visualizing distribution and density. |\n| `Matplot3DEx.ParametricCurve` | 2D plot of a parametric curve. |\n| `Matplot3DEx.PolarRose` | Polar plot representing a rose curve. |\n| `Matplot3DEx.ParametricSurface3D` | 3D parametric surface plot. |\n| `Matplot3DEx.SaddleSurface` | 3D plot of a saddle surface. |\n| `Matplot3DEx.QuaternionRotation` | 3D plot of a vector rotation using quaternions. |\n| `Matplot3DEx.TimeSeriesRollingAverage` | Time series plot with rolling average. |\n| `Matplot3DEx.HistogramOutlierDetection` | Histogram with outlier detection. |\n| `Matplot3DEx.ScatterRegressionPlot` | Scatter plot with linear regression line. |\n| `Matplot3DEx.StackedAreaTimeSeries` | Stacked area plot for time series data. |\n| `Matplot3DEx.ConfusionMatrixHeatmap` | Heatmap for visualizing confusion matrices. |\n\n\n## Advanced Features\n\nMatplot3DEx also provides advanced features for specific use cases:\n\n- **Data Science Module**: Includes classes for statistical analysis and data exploration.\n- **Math Module**: Incorporates mathematical plots and functions for mathematical visualizations.\n- **Add-Ons Module**: Additional classes that extend the functionality of Matplot3DEx.\n\n## More Usage\n\n### Example: 3D Scatter Plot\n\n```python\nimport numpy as np\nfrom Matplot3DEx import Matplot3DEx\n\n# Generate sample data\nx = np.random.rand(100)\ny = np.random.rand(100)\nz = np.random.rand(100)\n\n# Create a 3D scatter plot\nscatter_plot = Matplot3DEx.Scatter3D(x, y, z, title='3D Scatter Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nscatter_plot.show()\n```\n\n### Example: 3D Surface Plot\n\n```python\nimport numpy as np\nfrom Matplot3DEx import Matplot3DEx\n\n# Generate sample data\nx = np.linspace(-5, 5, 100)\ny = np.linspace(-5, 5, 100)\nx, y = np.meshgrid(x, y)\nz = x**2 - y**2\n\n# Create a 3D surface plot\nsurface_plot = Matplot3DEx.Surface3D(x, y, z, title='3D Surface Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nsurface_plot.show()\n```\n\n### Example: 2D Heatmap\n\n```python\nfrom Matplot3DEx import Matplot3DEx\nimport numpy as np\n\n# Generate sample data\ndata = np.random.rand(10, 10)\n\n# Create a 2D heatmap\nheatmap_plot = Matplot3DEx.Heatmap2D(data, title='2D Heatmap', xlabel='X-axis', ylabel='Y-axis')\nheatmap_plot.show()\n```\n\n### Example: Animated 3D Scatter Plot\n\n```python\nimport numpy as np\nfrom Matplot3DEx import Matplot3DEx\n\n# Generate sample data\nx = np.random.rand(100)\ny = np.random.rand(100)\nz = np.random.rand(100)\n\n# Create an animated 3D scatter plot\nanimated_scatter = Matplot3DEx.AnimatedScatter3D(x, y, z, title='Animated 3D Scatter Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nanimated_scatter.animate(frames=50, interval=100)\n```\n\n### Example: 2D Hexbin Plot\n\n```python\nimport numpy as np\nfrom Matplot3DEx import Matplot3DEx\n\n# Generate sample data\nx = np.random.normal(size=1000)\ny = np.random.normal(size=1000)\n\n# Create a 2D hexbin plot\nhexbin_plot = Matplot3DEx.Hexbin2D(x, y, gridsize=30, cmap='viridis')\nhexbin_plot.show()\n```\n\n### Example: 3D Quiver Plot\n\n```python\nimport numpy as np\nfrom Matplot3DEx import Matplot3DEx\n\n# Generate sample data\nx = np.linspace(-5, 5, 20)\ny = np.linspace(-5, 5, 20)\nz = np.linspace(-5, 5, 20)\nx, y, z = np.meshgrid(x, y, z)\nu = np.sin(x + y + z)\nv = np.cos(x - y - z)\nw = np.sin(2 * x)\n\n# Create a 3D quiver plot\nquiver_plot = Matplot3DEx.Quiver3D(x, y, z, u, v, w, title='3D Quiver Plot', xlabel='X-axis', ylabel='Y-axis', zlabel='Z-axis')\nquiver_plot.show()\n```\n\n## Contributing\n\nIf you find any issues or have suggestions for improvements, feel free to contribute! Visit the [GitHub repository](https://github.com/ishanoshada/matplot3dex) for more details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/ishanoshada/matplot3dex/blob/main/LICENSE) file for details.",
"bugtrack_url": null,
"license": "",
"summary": "A Matplotlib 3D Extension package for enhanced data visualization",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/ishanoshada/matplot3dex"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a60196c4d72d855c64d7284b0dee1f0c45b43b52af4d24ab1e3219fb3b92242",
"md5": "feb0c6e3c30559de9fa497283755346e",
"sha256": "f30b86bce840d5c6fee3cf1047363047c55423c94ad6bd348345fb6b45018ef7"
},
"downloads": -1,
"filename": "Matplot3DEx-0.1.tar.gz",
"has_sig": false,
"md5_digest": "feb0c6e3c30559de9fa497283755346e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8235,
"upload_time": "2023-11-21T10:01:26",
"upload_time_iso_8601": "2023-11-21T10:01:26.249540Z",
"url": "https://files.pythonhosted.org/packages/0a/60/196c4d72d855c64d7284b0dee1f0c45b43b52af4d24ab1e3219fb3b92242/Matplot3DEx-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 10:01:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ishanoshada",
"github_project": "matplot3dex",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "matplot3dex"
}
JSON
