visualizer-3d


Namevisualizer-3d JSON
Version 0.3.4 PyPI version JSON
download
home_pageNone
SummaryTool for three-dimensional animations of geometries like FE meshes
upload_time2024-12-04 16:28:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords visualiztion mesh
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Visualizer-3D 
Tool for three-dimensional animations of geometries like FE meshes.  

![gui](doc/gui.png)


# Features
This repository implements a OpenGL-based gui for three-dimensional animations of geometries like FE meshes. 
It can be used to visualize results, e.g. from transient simulations or to inspect the geometry itself.
Moreover, it can be used to export the animations for presentations or publications.

## Installation

You can either clone the repository and install the package locally or install it directly from PyPI.

### PyPI

```bash
pip install visualizer-3d
```

### Local
Clone this repository and install it to your local environment as package using pip:

```bash
git clone git@github.com:jkneifl/Visualizer.git
cd Visualizer
pip install -e .
```

## Usage

The base class `Visualizer` serves as tool for the visualization with its main method `animate` that can be used to create and export animations of geometries.

```python
from visualizer import Visualizer

coordinates = ...
faces = ...
colors = ...
# create a visualizer object
visualizer = Visualizer()
visualizer.animate(
    coordinates=coordinates,
)
```
It can animate point clouds, or meshes if the corresponding faces are provided.
For a detailed description of the parameters, see the docstring of the `animate` method.

You can also visualize multiple objects with different colors (specified by rgb values for every coordinate, by a string, or by error_values over an color map) and e.g. as points

```python
random_colors = np.random.rand(*coordinates.shape[0:2])
visualizer.animate([coordinates, coordinates, coordinates],
            faces=[None, faces, faces],
            color=["blue", colors, random_colors],
            shift=True,
            camera_distance=1000,
            )
```
![multiple](doc/multiple.png)

In the `examples` folder, you can find an example script with according data on how to use the `Visualizer` class.

You can also export the animations as gif or mp4 files. An example is shown below:

![arm](doc/arm_rotating.gif)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "visualizer-3d",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "visualiztion, mesh",
    "author": null,
    "author_email": "Jonas Kneifl <jonas.kneifl@itm.uni-stuttgart.com>",
    "download_url": "https://files.pythonhosted.org/packages/ab/14/8ab728d870627c03b8203be111f4e8230ae90f8796745ab1d94a04c7254d/visualizer_3d-0.3.4.tar.gz",
    "platform": null,
    "description": "# Visualizer-3D \nTool for three-dimensional animations of geometries like FE meshes.  \n\n![gui](doc/gui.png)\n\n\n# Features\nThis repository implements a OpenGL-based gui for three-dimensional animations of geometries like FE meshes. \nIt can be used to visualize results, e.g. from transient simulations or to inspect the geometry itself.\nMoreover, it can be used to export the animations for presentations or publications.\n\n## Installation\n\nYou can either clone the repository and install the package locally or install it directly from PyPI.\n\n### PyPI\n\n```bash\npip install visualizer-3d\n```\n\n### Local\nClone this repository and install it to your local environment as package using pip:\n\n```bash\ngit clone git@github.com:jkneifl/Visualizer.git\ncd Visualizer\npip install -e .\n```\n\n## Usage\n\nThe base class `Visualizer` serves as tool for the visualization with its main method `animate` that can be used to create and export animations of geometries.\n\n```python\nfrom visualizer import Visualizer\n\ncoordinates = ...\nfaces = ...\ncolors = ...\n# create a visualizer object\nvisualizer = Visualizer()\nvisualizer.animate(\n    coordinates=coordinates,\n)\n```\nIt can animate point clouds, or meshes if the corresponding faces are provided.\nFor a detailed description of the parameters, see the docstring of the `animate` method.\n\nYou can also visualize multiple objects with different colors (specified by rgb values for every coordinate, by a string, or by error_values over an color map) and e.g. as points\n\n```python\nrandom_colors = np.random.rand(*coordinates.shape[0:2])\nvisualizer.animate([coordinates, coordinates, coordinates],\n            faces=[None, faces, faces],\n            color=[\"blue\", colors, random_colors],\n            shift=True,\n            camera_distance=1000,\n            )\n```\n![multiple](doc/multiple.png)\n\nIn the `examples` folder, you can find an example script with according data on how to use the `Visualizer` class.\n\nYou can also export the animations as gif or mp4 files. An example is shown below:\n\n![arm](doc/arm_rotating.gif)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Tool for three-dimensional animations of geometries like FE meshes",
    "version": "0.3.4",
    "project_urls": {
        "Homepage": "https://github.com/jkneifl/visualizer",
        "Issues": "https://github.com/jkneifl/visualizer/issues"
    },
    "split_keywords": [
        "visualiztion",
        " mesh"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "61d46f5c728d42440e8787b00e16d169db3ce5e38346e31be1122010e7a0212d",
                "md5": "e706ad67bee6b108e4cfdf56b9f67554",
                "sha256": "db8981aaa1a98b0cfa80adc51e47deadb5329b1388692a8a2b1653c9e0e5b01c"
            },
            "downloads": -1,
            "filename": "visualizer_3d-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e706ad67bee6b108e4cfdf56b9f67554",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12456,
            "upload_time": "2024-12-04T16:28:00",
            "upload_time_iso_8601": "2024-12-04T16:28:00.231668Z",
            "url": "https://files.pythonhosted.org/packages/61/d4/6f5c728d42440e8787b00e16d169db3ce5e38346e31be1122010e7a0212d/visualizer_3d-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab148ab728d870627c03b8203be111f4e8230ae90f8796745ab1d94a04c7254d",
                "md5": "e954651903f537bb94af1ea910c4cf0e",
                "sha256": "1c71f92a73593617d10b7404438cbc852cc96fd2161e90fe7f5ab7a49bb75cc2"
            },
            "downloads": -1,
            "filename": "visualizer_3d-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "e954651903f537bb94af1ea910c4cf0e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13322,
            "upload_time": "2024-12-04T16:28:04",
            "upload_time_iso_8601": "2024-12-04T16:28:04.973200Z",
            "url": "https://files.pythonhosted.org/packages/ab/14/8ab728d870627c03b8203be111f4e8230ae90f8796745ab1d94a04c7254d/visualizer_3d-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-04 16:28:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jkneifl",
    "github_project": "visualizer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "visualizer-3d"
}
        
Elapsed time: 0.39612s