| Name | gustaf JSON |
| Version |
0.0.25
JSON |
| download |
| home_page | None |
| Summary | Process and visualize numerical-analysis-geometries. |
| upload_time | 2024-05-06 14:29:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021 Jaewook Lee Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gustaf/utils/arr.py:unique_rows Copyright (C) 2019, the scikit-image team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of skimage nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. gustaf/veritces.py:update_vertices gustaf/vertices.py:remove_unreferenced_vertices gustaf/helpers/data.py:TrackedArray, make_tracked_array The MIT License (MIT) Copyright (c) 2019 Michael Dawson-Haggerty Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gustaf/helpers/notebook.py:get_shape MIT License Copyright (c) 2017 Marco Musy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
numerical-analysis
geometry
visualization
mesh
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
__gustaf__ is a Python library to process and visualize numerical-analysis-geometries;
gustaf currently supports the following elements:
- points,
- lines,
- triangle,
- quadrilateral,
- tetrahedron, and
- hexahedron.
# Installation
`gustaf` only has `numpy` for its strict dependency. The minimal version can be installed using `pip`.
```
pip install gustaf
```
To install all the [optional dependencies](#optional-dependencies) at the same time, you can use:
```
# quotation marks required for some shells
pip install "gustaf[all]"
```
For the latest develop version of gustaf:
```
pip install git+https://github.com/tataratat/gustaf.git@main
```
# Quick Start
This example shows how to create volume elements and plot data on them.
For visualization, gustaf uses [vedo](https://vedo.embl.es) as main backend.
To begin we need to import the needed libraries:
```python
import gustaf as gus
import numpy as np
```
## Create a tetrahedron
Now we create our first volume. It will be just a basic cube. Even here we can
already choose between using a tetrahedron and a hexahedron-based
mesh. The `Volumes` class will use tetrahedrons if the volumes keyword is made
up of a list of 4 elements (defining the corners of the tetrahedron), if 8
elements are in each list hexahedrons are used ([defining the corners of the hexahedron in the correct order](https://tataratat.github.io/gustaf/_generated/gustaf.utils.connec.make_hexa_volumes.html#gustaf.utils.connec.make_hexa_volumes)).
```python
# create tetrahedron mesh using Volumes
# it requires vertices and connectivity info, volumes
tet = gus.Volumes(
vertices=[
[0.0, 0.0, 0.0],
[1.0, 0.0, 0.0],
[0.0, 1.0, 0.0],
[1.0, 1.0, 0.0],
[0.0, 0.0, 1.0],
[1.0, 0.0, 1.0],
[0.0, 1.0, 1.0],
[1.0, 1.0, 1.0],
],
volumes=[
[0, 2, 7, 3],
[0, 2, 6, 7],
[0, 6, 4, 7],
[5, 0, 4, 7],
[5, 0, 7, 1],
[7, 0, 3, 1],
],
)
# set line color and width
tet.show_options["lc"] = "black"
tet.show_options["lw"] = 4
tet.show(background="grey")
```
```python
hexa = gus.Volumes(
vertices=[
[0.0, 0.0, 0.0], #0
[1.0, 0.0, 0.0], #1
[0.0, 1.0, 0.0],
[1.0, 1.0, 0.0], #3
[0.0, 0.0, 1.0],
[1.0, 0.0, 1.0],
[0.0, 1.0, 1.0], #6
[1.0, 1.0, 1.0],
],
volumes=[
[0, 1, 3, 2, 4, 5, 7, 6],
],
)
hexa.show_options["lc"] = "black"
hexa.show_options["lw"] = 4
hexa.show(background="grey")
```
## Basic visualization
As just shown, it is really easy to show the objects by just calling the
`show()` function on the object. But that is just the beginning of the
possibilities in vedo. You can plot multiple objects next to each other:
```python
# show multiple items in one plot
# each list will be put into a separate subplot.
gus.show(
["Tetrahedron", tet],
["Hexahedron", hexa]
)
```
Now let's add a color map to the object for the norm of the
coordinate, and let us also add at each vertex an arrow with random direction
and length.
```python
# let's visualize some scalar data and vector data defined on vertices
tet.vertex_data["arange"] = np.arange(len(tet.vertices)) # scalar
tet.show_options["data"] = "arange"
tet.vertex_data["random"] = np.random.random((len(tet.vertices), 3)) # vector
tet.show_options["arrow_data"] = "random"
tet.show(background="grey")
```
Are you interested in splines?
Please checkout [splinepy](https://tataratat.github.io/splinepy/)!
# Optional Dependencies
| Package | Description |
| ------- | ----------- |
| [numpy](https://numpy.org) | Fast array data operations. |
| [vedo](https://vedo.embl.es) | Default renderer / visualization core of gustaf. |
| [scipy](https://scipy.org) | Create k-d trees and simple rotation matrices.|
| [napf](https://github.com/tataratat/napf) | Fast k-d tree build / query based on nanoflann. Supersedes scipy if it is importable. |
| [funi](https://github.com/tataratat/funi) | A different method to find unique float array rows. But faster than k-d trees! |
| [meshio](https://github.com/nschloe/meshio) | Supports loading/exporting numerous mesh formats. |
Raw data
{
"_id": null,
"home_page": null,
"name": "gustaf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "numerical-analysis, geometry, visualization, mesh",
"author": null,
"author_email": "Jaewook Lee <jaewooklee042@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/6e/34c8dabcc12774fbfcc1a990a30e3187fec910568f2b4fcd5d23564a6cb3/gustaf-0.0.25.tar.gz",
"platform": null,
"description": "\n\n__gustaf__ is a Python library to process and visualize numerical-analysis-geometries;\ngustaf currently supports the following elements:\n- points,\n- lines,\n- triangle,\n- quadrilateral,\n- tetrahedron, and\n- hexahedron.\n\n# Installation\n`gustaf` only has `numpy` for its strict dependency. The minimal version can be installed using `pip`.\n```\npip install gustaf\n```\nTo install all the [optional dependencies](#optional-dependencies) at the same time, you can use:\n```\n# quotation marks required for some shells\npip install \"gustaf[all]\"\n```\nFor the latest develop version of gustaf:\n```\npip install git+https://github.com/tataratat/gustaf.git@main\n```\n\n# Quick Start\nThis example shows how to create volume elements and plot data on them.\nFor visualization, gustaf uses [vedo](https://vedo.embl.es) as main backend.\n\nTo begin we need to import the needed libraries:\n\n```python\nimport gustaf as gus\nimport numpy as np\n```\n## Create a tetrahedron\nNow we create our first volume. It will be just a basic cube. Even here we can\nalready choose between using a tetrahedron and a hexahedron-based\nmesh. The `Volumes` class will use tetrahedrons if the volumes keyword is made\nup of a list of 4 elements (defining the corners of the tetrahedron), if 8\nelements are in each list hexahedrons are used ([defining the corners of the hexahedron in the correct order](https://tataratat.github.io/gustaf/_generated/gustaf.utils.connec.make_hexa_volumes.html#gustaf.utils.connec.make_hexa_volumes)).\n```python\n# create tetrahedron mesh using Volumes\n# it requires vertices and connectivity info, volumes\ntet = gus.Volumes(\n vertices=[\n [0.0, 0.0, 0.0],\n [1.0, 0.0, 0.0],\n [0.0, 1.0, 0.0],\n [1.0, 1.0, 0.0],\n [0.0, 0.0, 1.0],\n [1.0, 0.0, 1.0],\n [0.0, 1.0, 1.0],\n [1.0, 1.0, 1.0],\n ],\n volumes=[\n [0, 2, 7, 3],\n [0, 2, 6, 7],\n [0, 6, 4, 7],\n [5, 0, 4, 7],\n [5, 0, 7, 1],\n [7, 0, 3, 1],\n ],\n)\n\n# set line color and width\ntet.show_options[\"lc\"] = \"black\"\ntet.show_options[\"lw\"] = 4\n\ntet.show(background=\"grey\")\n```\n\n```python\nhexa = gus.Volumes(\n vertices=[\n [0.0, 0.0, 0.0], #0\n [1.0, 0.0, 0.0], #1\n [0.0, 1.0, 0.0],\n [1.0, 1.0, 0.0], #3\n [0.0, 0.0, 1.0],\n [1.0, 0.0, 1.0],\n [0.0, 1.0, 1.0], #6\n [1.0, 1.0, 1.0],\n ],\n volumes=[\n [0, 1, 3, 2, 4, 5, 7, 6],\n ],\n)\n\nhexa.show_options[\"lc\"] = \"black\"\nhexa.show_options[\"lw\"] = 4\n\nhexa.show(background=\"grey\")\n```\n\n## Basic visualization\n\nAs just shown, it is really easy to show the objects by just calling the\n`show()` function on the object. But that is just the beginning of the\npossibilities in vedo. You can plot multiple objects next to each other:\n```python\n# show multiple items in one plot\n# each list will be put into a separate subplot.\ngus.show(\n [\"Tetrahedron\", tet],\n [\"Hexahedron\", hexa]\n)\n```\n\n\nNow let's add a color map to the object for the norm of the\ncoordinate, and let us also add at each vertex an arrow with random direction\nand length.\n```python\n# let's visualize some scalar data and vector data defined on vertices\ntet.vertex_data[\"arange\"] = np.arange(len(tet.vertices)) # scalar\ntet.show_options[\"data\"] = \"arange\"\ntet.vertex_data[\"random\"] = np.random.random((len(tet.vertices), 3)) # vector\ntet.show_options[\"arrow_data\"] = \"random\"\ntet.show(background=\"grey\")\n```\n\n\nAre you interested in splines?\nPlease checkout [splinepy](https://tataratat.github.io/splinepy/)!\n\n\n# Optional Dependencies\n| Package | Description |\n| ------- | ----------- |\n| [numpy](https://numpy.org) | Fast array data operations. |\n| [vedo](https://vedo.embl.es) | Default renderer / visualization core of gustaf. |\n| [scipy](https://scipy.org) | Create k-d trees and simple rotation matrices.|\n| [napf](https://github.com/tataratat/napf) | Fast k-d tree build / query based on nanoflann. Supersedes scipy if it is importable. |\n| [funi](https://github.com/tataratat/funi) | A different method to find unique float array rows. But faster than k-d trees! |\n| [meshio](https://github.com/nschloe/meshio) | Supports loading/exporting numerous mesh formats. |\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Jaewook Lee Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gustaf/utils/arr.py:unique_rows Copyright (C) 2019, the scikit-image team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of skimage nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. gustaf/veritces.py:update_vertices gustaf/vertices.py:remove_unreferenced_vertices gustaf/helpers/data.py:TrackedArray, make_tracked_array The MIT License (MIT) Copyright (c) 2019 Michael Dawson-Haggerty Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. gustaf/helpers/notebook.py:get_shape MIT License Copyright (c) 2017 Marco Musy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Process and visualize numerical-analysis-geometries.",
"version": "0.0.25",
"project_urls": null,
"split_keywords": [
"numerical-analysis",
" geometry",
" visualization",
" mesh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23d4b45baaf6d1ac8c0dd82c8d5521c957c2624cd6fa7241034f4738c573cd9c",
"md5": "775395bdd531c196f64dbaebfdc79077",
"sha256": "53d9378959c141b0fcbc176df8553790d846b26de1d5d70c21ddcd9223bb22de"
},
"downloads": -1,
"filename": "gustaf-0.0.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "775395bdd531c196f64dbaebfdc79077",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 68524,
"upload_time": "2024-05-06T14:29:57",
"upload_time_iso_8601": "2024-05-06T14:29:57.046377Z",
"url": "https://files.pythonhosted.org/packages/23/d4/b45baaf6d1ac8c0dd82c8d5521c957c2624cd6fa7241034f4738c573cd9c/gustaf-0.0.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a56e34c8dabcc12774fbfcc1a990a30e3187fec910568f2b4fcd5d23564a6cb3",
"md5": "a8989b076ebd34d36f4ad4c940ab50dc",
"sha256": "1db3d761950eb5e02b8f3990a56027aa20782f41818f9a631dccf5332cc0f406"
},
"downloads": -1,
"filename": "gustaf-0.0.25.tar.gz",
"has_sig": false,
"md5_digest": "a8989b076ebd34d36f4ad4c940ab50dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 63666,
"upload_time": "2024-05-06T14:29:59",
"upload_time_iso_8601": "2024-05-06T14:29:59.025363Z",
"url": "https://files.pythonhosted.org/packages/a5/6e/34c8dabcc12774fbfcc1a990a30e3187fec910568f2b4fcd5d23564a6cb3/gustaf-0.0.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 14:29:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gustaf"
}
