| Name | FourierAnim JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | |
| Summary | An animation tool to create visualisations for Fourier Series on top of manimCE |
| upload_time | 2024-02-24 05:53:23 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Matthew 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 |
math
animation
fourier
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Installation
Please ensure that manimCE (>v18.0.0) is installed on your machine before using this package. We reccomend running the program in a conda environment. This requires you to install [anaconda](https://www.anaconda.com/download/) or [miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/). Otherwise, you may also wish to install manim locally please refer to the official guide [here](https://docs.manim.community/en/stable/installation.html).
To install this package in a conda environment follow the steps on manim's conda installation [here](https://docs.manim.community/en/stable/installation.html#conda-installation).
Otherwise run the following,
```
conda create -n my-manim-environment
conda activate my-manim-environment
conda install -c conda-forge manim
```
Finally install the package (still in the conda environment)
`pip install FourierAnim`
# Usage
To use the package, import the package into your file and work as usual. As example is displayed below.
```
# T1.py
from manim import *
import FourierAnim as FSA
class F_T1(MovingCameraScene):
def construct(self):
self.camera.background_color = WHITE
Tex.set_default(color=BLACK, font_size=35)
FSA.FourierAnim(
self,
radii = [1, 1/2, 1/3],
freqs = [1, 2, 3],
ScnMobjects=[],
run_time=10,
)
```
This file is saved as T1.py (although it could be called anything)
To generate the video run,
`python -m manim T1.py F_T1`
You can find the sample output [here](https://youtu.be/E4ipxXQqtDc)
Raw data
{
"_id": null,
"home_page": "",
"name": "FourierAnim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "math,animation,fourier",
"author": "",
"author_email": "Shaheer Ziya <shaheer@connect.hku.hk>",
"download_url": "https://files.pythonhosted.org/packages/3a/f7/05e9dc85d09a41ec13aadf756865fceeab93e3abd9d5d345afc38aafac40/FourierAnim-1.1.2.tar.gz",
"platform": null,
"description": "# Installation\n\nPlease ensure that manimCE (>v18.0.0) is installed on your machine before using this package. We reccomend running the program in a conda environment. This requires you to install [anaconda](https://www.anaconda.com/download/) or [miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/). Otherwise, you may also wish to install manim locally please refer to the official guide [here](https://docs.manim.community/en/stable/installation.html).\n\nTo install this package in a conda environment follow the steps on manim's conda installation [here](https://docs.manim.community/en/stable/installation.html#conda-installation).\n\nOtherwise run the following,\n\n```\nconda create -n my-manim-environment\nconda activate my-manim-environment\nconda install -c conda-forge manim\n```\n\nFinally install the package (still in the conda environment)\n\n`pip install FourierAnim`\n\n# Usage\n\nTo use the package, import the package into your file and work as usual. As example is displayed below.\n\n```\n# T1.py\nfrom manim import *\nimport FourierAnim as FSA\nclass F_T1(MovingCameraScene):\n def construct(self):\n self.camera.background_color = WHITE\n Tex.set_default(color=BLACK, font_size=35)\n\n FSA.FourierAnim(\n self,\n radii = [1, 1/2, 1/3],\n freqs = [1, 2, 3],\n ScnMobjects=[],\n run_time=10,\n )\n```\n\nThis file is saved as T1.py (although it could be called anything)\n\nTo generate the video run,\n\n`python -m manim T1.py F_T1`\n\nYou can find the sample output [here](https://youtu.be/E4ipxXQqtDc)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Matthew 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": "An animation tool to create visualisations for Fourier Series on top of manimCE",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/MatthewSummons/FourierAnim.git"
},
"split_keywords": [
"math",
"animation",
"fourier"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d8aca5c81138ce1b0796a702ade31191a0aa8da5be6dcea982abb54291c76c7",
"md5": "fcf4b23059b22809a004bbb8617b0139",
"sha256": "0bdb4f20bab2b89f98271fea063e0cca7dec98927a634533b2c5842c8042350d"
},
"downloads": -1,
"filename": "FourierAnim-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcf4b23059b22809a004bbb8617b0139",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5518,
"upload_time": "2024-02-24T05:53:21",
"upload_time_iso_8601": "2024-02-24T05:53:21.958227Z",
"url": "https://files.pythonhosted.org/packages/5d/8a/ca5c81138ce1b0796a702ade31191a0aa8da5be6dcea982abb54291c76c7/FourierAnim-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3af705e9dc85d09a41ec13aadf756865fceeab93e3abd9d5d345afc38aafac40",
"md5": "8ff6f72de76c0155cf1814c7068cf8cb",
"sha256": "f32cbd4bc52935cbbd363212c945b87e179c4f1ad9845727a0553dfb43a43fcd"
},
"downloads": -1,
"filename": "FourierAnim-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "8ff6f72de76c0155cf1814c7068cf8cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4729,
"upload_time": "2024-02-24T05:53:23",
"upload_time_iso_8601": "2024-02-24T05:53:23.641936Z",
"url": "https://files.pythonhosted.org/packages/3a/f7/05e9dc85d09a41ec13aadf756865fceeab93e3abd9d5d345afc38aafac40/FourierAnim-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 05:53:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MatthewSummons",
"github_project": "FourierAnim",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fourieranim"
}
