| Name | hmanim JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | The hyperbolic extension of manim! |
| upload_time | 2024-12-24 13:48:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Maximilian Katzmann 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 |
animation
visualization
hyperbolic
geometry
math
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
alabaster
babel
beautifulsoup4
black
certifi
charset-normalizer
click
cloup
colour
Cython
decorator
docutils
furo
glcontext
idna
imagesize
isort
isosurfaces
Jinja2
manim
ManimPango
mapbox_earcut
markdown-it-py
MarkupSafe
mdurl
moderngl
moderngl-window
multipledispatch
mypy-extensions
networkx
numpy
packaging
pathspec
pillow
platformdirs
pycairo
pydub
pyglet
Pygments
pyobjc-core
pyobjc-framework-Cocoa
pyrr
requests
rich
scipy
screeninfo
skia-pathops
snowballstemmer
soupsieve
Sphinx
sphinx-basic-ng
sphinxcontrib-applehelp
sphinxcontrib-devhelp
sphinxcontrib-htmlhelp
sphinxcontrib-jsmath
sphinxcontrib-qthelp
sphinxcontrib-serializinghtml
srt
svgelements
tqdm
typing_extensions
urllib3
watchdog
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# HManim
The hyperbolic extension of [Manim](https://www.manim.community). This package
allows for using Manim's drawing and animation framework to visualize objects
in the hyperbolic plane.
For a comprehensive description we refer to the [documentation](https://maxkatzmann.github.io/hmanim/).
## Installation
You can install the package by running
``` bash
pip install hmanim
```
Note that we recommend installing HManim in a virtual environment.
## Usage
Define a scene in a Python file (e.g., `scene.py`), define a class that derives
from Manim's `Scene`, and override its `construct` method.
``` python
from hmanim import native
from manim import Scene, PolarPlane
class ExampleScene(Scene):
def construct(self):
plane = PolarPlane(size=5)
circle = native.Circle(
center=native.Point(),
radius=5.0,
plane=plane,
)
self.add(circle)
self.play(native.Translate(circle, 3.0))
```
Then you render the scene by running
``` bash
python -m manim -p scene.py ExampleScene
```
Note that `-p` is used to show a preview of the created video once it is
rendered.
The resulting files can then be found in the created `media` directory.
For more examples, we refer to the
[documentation](https://maxkatzmann.github.io/hmanim/).
## Building the Documentation
The documentation content is split into two directories.
1. The `documentation` directory contains the source files that are used to
build the documentation.
2. The `docs` directory contains the built documentation files that are served
as a website.
To build the documentation, go to the `documentation` directory and run `make
html`.
## Known Issues
Changing the center of projection of an `HArc` or `HClosedArc` may lead to
graphical glitches, since the rendering is not optimized for projection changes yet.
The Poincaré module is currently missing the functionality to draw hyperbolic circles.
Raw data
{
"_id": null,
"home_page": null,
"name": "hmanim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "animation, visualization, hyperbolic, geometry, math",
"author": null,
"author_email": "Maximilian Katzmann <max.katzmann@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/51/65/b312365b765fb908e225bff66e899450364aed04b561315605567f39e93c/hmanim-0.1.0.tar.gz",
"platform": null,
"description": "# HManim\n\nThe hyperbolic extension of [Manim](https://www.manim.community). This package\nallows for using Manim's drawing and animation framework to visualize objects\nin the hyperbolic plane.\n\nFor a comprehensive description we refer to the [documentation](https://maxkatzmann.github.io/hmanim/).\n\n## Installation\n\nYou can install the package by running\n\n``` bash\npip install hmanim\n```\n\nNote that we recommend installing HManim in a virtual environment.\n\n## Usage\n\nDefine a scene in a Python file (e.g., `scene.py`), define a class that derives\nfrom Manim's `Scene`, and override its `construct` method.\n\n``` python\nfrom hmanim import native\nfrom manim import Scene, PolarPlane\n\nclass ExampleScene(Scene):\n def construct(self):\n plane = PolarPlane(size=5)\n\n circle = native.Circle(\n center=native.Point(),\n radius=5.0,\n plane=plane,\n )\n\n self.add(circle)\n self.play(native.Translate(circle, 3.0))\n```\n\nThen you render the scene by running\n\n``` bash\npython -m manim -p scene.py ExampleScene\n```\n\nNote that `-p` is used to show a preview of the created video once it is\nrendered.\n\nThe resulting files can then be found in the created `media` directory.\n\nFor more examples, we refer to the\n[documentation](https://maxkatzmann.github.io/hmanim/).\n\n## Building the Documentation\n\nThe documentation content is split into two directories.\n\n1. The `documentation` directory contains the source files that are used to\n build the documentation.\n2. The `docs` directory contains the built documentation files that are served\n as a website.\n\nTo build the documentation, go to the `documentation` directory and run `make\nhtml`.\n\n## Known Issues\n\nChanging the center of projection of an `HArc` or `HClosedArc` may lead to\ngraphical glitches, since the rendering is not optimized for projection changes yet.\n\nThe Poincar\u00e9 module is currently missing the functionality to draw hyperbolic circles.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Maximilian Katzmann 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": "The hyperbolic extension of manim!",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/maxkatzmann/hmanim"
},
"split_keywords": [
"animation",
" visualization",
" hyperbolic",
" geometry",
" math"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b09578d866af13549b7fefbeb74c18979ff219fc3de3d6202128086e31a7ac8b",
"md5": "465e8e45ce9e9e8ed1995d84629d659f",
"sha256": "24e66b5d3548b4d5f47ec45c04cb7fb63ced0c640c294369c8f8f3e87cb98830"
},
"downloads": -1,
"filename": "hmanim-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "465e8e45ce9e9e8ed1995d84629d659f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 49788,
"upload_time": "2024-12-24T13:47:57",
"upload_time_iso_8601": "2024-12-24T13:47:57.225666Z",
"url": "https://files.pythonhosted.org/packages/b0/95/78d866af13549b7fefbeb74c18979ff219fc3de3d6202128086e31a7ac8b/hmanim-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5165b312365b765fb908e225bff66e899450364aed04b561315605567f39e93c",
"md5": "55a9f8d3e9dffa15d7f7be8e82242992",
"sha256": "9280f89ad230f03164f91e8fbb2e0d7621fe3cef2400d1592b78466e07435700"
},
"downloads": -1,
"filename": "hmanim-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "55a9f8d3e9dffa15d7f7be8e82242992",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 33464,
"upload_time": "2024-12-24T13:48:00",
"upload_time_iso_8601": "2024-12-24T13:48:00.015722Z",
"url": "https://files.pythonhosted.org/packages/51/65/b312365b765fb908e225bff66e899450364aed04b561315605567f39e93c/hmanim-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 13:48:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxkatzmann",
"github_project": "hmanim",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "alabaster",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "babel",
"specs": [
[
"==",
"2.16.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"24.10.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.8.30"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "cloup",
"specs": [
[
"==",
"3.0.5"
]
]
},
{
"name": "colour",
"specs": [
[
"==",
"0.1.5"
]
]
},
{
"name": "Cython",
"specs": [
[
"==",
"3.0.11"
]
]
},
{
"name": "decorator",
"specs": [
[
"==",
"5.1.1"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.21.2"
]
]
},
{
"name": "furo",
"specs": [
[
"==",
"2024.8.6"
]
]
},
{
"name": "glcontext",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "imagesize",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "isort",
"specs": [
[
"==",
"5.13.2"
]
]
},
{
"name": "isosurfaces",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.4"
]
]
},
{
"name": "manim",
"specs": [
[
"==",
"0.18.1"
]
]
},
{
"name": "ManimPango",
"specs": [
[
"==",
"0.6.0"
]
]
},
{
"name": "mapbox_earcut",
"specs": [
[
"==",
"1.0.2"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "moderngl",
"specs": [
[
"==",
"5.12.0"
]
]
},
{
"name": "moderngl-window",
"specs": [
[
"==",
"2.4.6"
]
]
},
{
"name": "multipledispatch",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "mypy-extensions",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "networkx",
"specs": [
[
"==",
"3.4.2"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.2"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "pillow",
"specs": [
[
"==",
"11.0.0"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.3.6"
]
]
},
{
"name": "pycairo",
"specs": [
[
"==",
"1.27.0"
]
]
},
{
"name": "pydub",
"specs": [
[
"==",
"0.25.1"
]
]
},
{
"name": "pyglet",
"specs": [
[
"==",
"2.0.18"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pyobjc-core",
"specs": [
[
"==",
"10.3.1"
]
]
},
{
"name": "pyobjc-framework-Cocoa",
"specs": [
[
"==",
"10.3.1"
]
]
},
{
"name": "pyrr",
"specs": [
[
"==",
"0.10.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.9.4"
]
]
},
{
"name": "scipy",
"specs": [
[
"==",
"1.14.1"
]
]
},
{
"name": "screeninfo",
"specs": [
[
"==",
"0.8.1"
]
]
},
{
"name": "skia-pathops",
"specs": [
[
"==",
"0.8.0.post2"
]
]
},
{
"name": "snowballstemmer",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.6"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"8.1.3"
]
]
},
{
"name": "sphinx-basic-ng",
"specs": [
[
"==",
"1.0.0b2"
]
]
},
{
"name": "sphinxcontrib-applehelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-devhelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-htmlhelp",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "sphinxcontrib-jsmath",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "sphinxcontrib-qthelp",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-serializinghtml",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "srt",
"specs": [
[
"==",
"3.5.3"
]
]
},
{
"name": "svgelements",
"specs": [
[
"==",
"1.9.6"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.67.0"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.12.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.3"
]
]
},
{
"name": "watchdog",
"specs": [
[
"==",
"6.0.0"
]
]
}
],
"lcname": "hmanim"
}
