| Name | manim-slides JSON |
| Version |
5.1.10
JSON |
| download |
| home_page | None |
| Summary | Tool for live presentations using manim |
| upload_time | 2024-12-03 11:58:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
manim
manimgl
plugin
slides
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://www.github.com/jeertmans/manin-slides">
<img src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png"/>
</a>
</p>
[![Latest Release][pypi-version-badge]][pypi-version-url]
[![Python version][pypi-python-version-badge]][pypi-version-url]
[![PyPI - Downloads][pypi-download-badge]][pypi-version-url]
[![Documentation][documentation-badge]][documentation-url]
[![DOI][doi-badge]][doi-url]
[![JOSE Paper][jose-badge]][jose-url]
[![codecov][codecov-badge]][codecov-url]
[![Binder][binder-badge]][binder-url]
# Manim Slides
Tool for live presentations using either
[Manim (community edition)](https://www.manim.community/)
or [ManimGL](https://3b1b.github.io/manim/).
Manim Slides will *automatically* detect the one you are using!
> **NOTE:**
> This project extends the work of
> [`manim-presentation`](https://github.com/galatolofederico/manim-presentation),
> with a lot more features!
- [Installation](#installation)
- [Usage](#usage)
- [Comparison with Similar Tools](#comparison-with-similar-tools)
- [F.A.Q](https://eertmans.be/manim-slides/latest/faq.html)
- [Citing](#citing)
- [Contributing](#contributing)
* [Reporting an Issue](#reporting-an-issue)
* [Seeking for Help](#seeking-for-help)
* [Contact](#contact)
## Installation
Manim Slides requires either Manim or ManimGL to be installed, along
with their dependencies. Please checkout the
[documentation](https://eertmans.be/manim-slides/latest/installation.html)
for detailed install instructions.
## Usage
<!-- start usage -->
Using Manim Slides is a two-step process:
1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead
of `Scene` (resp. `ThreeDScene`), and add calls to `self.next_slide()`
every time you want to create a new slide.
2. Run `manim-slides` on rendered animations and display them like a
*PowerPoint* presentation.
The documentation is available [online](https://eertmans.be/manim-slides/).
### Basic Example
Call `self.next_slide()` every time you want to create a pause between
animations, and `self.next_slide(loop=True)` if you want the next slide to loop
over animations until the user presses continue:
```python
from manim import * # or: from manimlib import *
from manim_slides import Slide
class BasicExample(Slide):
def construct(self):
circle = Circle(radius=3, color=BLUE)
dot = Dot()
self.play(GrowFromCenter(circle))
self.next_slide() # Waits user to press continue to go to the next slide
self.next_slide(loop=True) # Start loop
self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
self.next_slide() # This will start a new non-looping slide
self.play(dot.animate.move_to(ORIGIN))
```
First, render the animation files:
```bash
manim-slides render example.py BasicExample
# or use ManimGL
manim-slides render --GL example.py BasicExample
```
<!-- end usage -->
> **NOTE:**
> Using `manim-slides render` makes sure to use the `manim`
> (or `manimlib`) library that was installed in the same Python environment.
> Put simply, this is a wrapper around
> `manim render [ARGS]...` (or `manimgl [ARGS]...`).
<!-- start more-usage -->
To start the presentation using `Scene1`, `Scene2` and so on, run:
```bash
manim-slides [OPTIONS] Scene1 Scene2...
```
In our example:
```bash
manim-slides BasicExample
```
<!-- end more-usage -->
<p align="center">
<img alt="Example GIF" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/example.gif">
</p>
For detailed usage documentation, run `manim-slides --help`, or go to the
[documentation](https://eertmans.be/manim-slides/latest/reference/cli.html).
## Interactive Tutorial
Click on the image to watch a slides presentation that explains to you how
to use Manim Slides.
[](https://eertmans.be/manim-slides/)
## More Examples
More examples are available in the
[`example.py`](https://github.com/jeertmans/manim-slides/blob/main/example.py)
file, if you downloaded the git repository.
## Comparison with Similar Tools
There exists a variety of tools that allows to create slides presentations
containing Manim animations.
Below is a comparison of the most used ones with Manim Slides:
| Project name | Manim Slides | Manim Presentation | Manim Editor | Jupyter Notebooks |
|:------------:|:------------:|:------------------:|:------------:|:-----------------:|
| Link | [](https://github.com/jeertmans/manim-slides) | [](https://github.com/galatolofederico/manim-presentation) | [](https://github.com/ManimCommunity/manim_editor) | [](https://github.com/jupyter/notebook) |
| Activity | [](https://github.com/jeertmans/manim-slides) | [](https://github.com/galatolofederico/manim-presentation) | [](https://github.com/ManimCommunity/manim_editor) | [](https://github.com/jupyter/notebook) |
| Usage | Command-line | Command-line | Web Browser | Notebook |
| Note | Requires minimal modif. in scenes files | Requires minimal modif. in scenes files | Requires the usage of sections, and configuration through graphical interface | Relies on `nbconvert` to create slides from a Notebook |
| Support for ManimGL | Yes | No | No | No |
| Web Browser presentations | Yes | No | Yes | No |
| Offline presentations | Yes, with Qt | Yes, with OpenCV | No | No
## Citing
If you use this project, please cite it using the following reference:
```bibtex
@article{Jerome_Eertmans_Manim_Slides_A_2023,
title = {{Manim Slides: A Python package for presenting Manim content anywhere}},
author = {{Jérome Eertmans}},
year = 2023,
month = aug,
journal = {Journal of Open Source Education},
volume = 6,
doi = {10.21105/jose.00206}
}
```
or by linking this GitHub repository at the end of the presentation.
## Contributing
Contributions are more than welcome! Please read through
[our contributing section](https://eertmans.be/manim-slides/latest/contributing/index.html).
### Reporting an Issue
<!-- start reporting-an-issue -->
If you think you found a bug,
an error in the documentation,
or wish there was some feature that is currently missing,
we would love to hear from you!
The best way to reach us is via the
[GitHub issues](https://github.com/jeertmans/manim-slides/issues).
If your problem is not covered by an already existing (closed or open) issue,
then we suggest you create a
[new issue](https://github.com/jeertmans/manim-slides/issues/new/choose).
You can choose from a list of templates, or open a
[blank issue](https://github.com/jeertmans/manim-slides/issues/new)
if your issue does not fit one of the proposed topics.
The more precise you are in the description of your problem, the faster we will
be able to help you!
<!-- end reporting-an-issue -->
### Seeking for help
<!-- start seeking-for-help -->
Sometimes, you may have a question about Manim Slides,
not necessarily an issue.
First, make sure to read the
[F.A.Q](https://eertmans.be/manim-slides/latest/faq.html) to see if
your question has already been answered. If not, please follow the
recommendation (from that page) to reach us for questions.
<!-- end seeking-for-help -->
### Contact
<!-- start contact -->
Finally, if you do not have any GitHub account,
or just wish to contact the author of Manim Slides,
you can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com).
<!-- end contact -->
[pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides
[pypi-version-url]: https://pypi.org/project/manim-slides/
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/manim-slides
[pypi-download-badge]: https://img.shields.io/pypi/dm/manim-slides
[documentation-badge]: https://readthedocs.org/projects/manim-slides/badge/?version=latest
[documentation-url]: https://manim-slides.readthedocs.io/
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.8215167.svg
[doi-url]: https://doi.org/10.5281/zenodo.8215167
[jose-badge]: https://jose.theoj.org/papers/10.21105/jose.00206/status.svg
[jose-url]: https://doi.org/10.21105/jose.00206
[codecov-badge]: https://codecov.io/gh/jeertmans/manim-slides/branch/main/graph/badge.svg?token=8P4DY9JCE4
[codecov-url]: https://codecov.io/gh/jeertmans/manim-slides
[binder-badge]: https://mybinder.org/badge_logo.svg
[binder-url]: https://mybinder.org/v2/gh/jeertmans/manim-slides-binder/HEAD?filepath=getting_started.ipynb
Raw data
{
"_id": null,
"home_page": null,
"name": "manim-slides",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "manim, manimgl, plugin, slides",
"author": null,
"author_email": "J\u00e9rome Eertmans <jeertmans@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/21/27/7d5128b45f184a6b19e9b1d56765746b1f244b9c3def11759c3719733630/manim_slides-5.1.10.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://www.github.com/jeertmans/manin-slides\">\n <img src=\"https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png\"/>\n </a>\n</p>\n\n\n[![Latest Release][pypi-version-badge]][pypi-version-url]\n[![Python version][pypi-python-version-badge]][pypi-version-url]\n[![PyPI - Downloads][pypi-download-badge]][pypi-version-url]\n[![Documentation][documentation-badge]][documentation-url]\n[![DOI][doi-badge]][doi-url]\n[![JOSE Paper][jose-badge]][jose-url]\n[![codecov][codecov-badge]][codecov-url]\n[![Binder][binder-badge]][binder-url]\n\n# Manim Slides\n\nTool for live presentations using either\n[Manim (community edition)](https://www.manim.community/)\nor [ManimGL](https://3b1b.github.io/manim/).\nManim Slides will *automatically* detect the one you are using!\n\n> **NOTE:**\n> This project extends the work of\n> [`manim-presentation`](https://github.com/galatolofederico/manim-presentation),\n> with a lot more features!\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Comparison with Similar Tools](#comparison-with-similar-tools)\n- [F.A.Q](https://eertmans.be/manim-slides/latest/faq.html)\n- [Citing](#citing)\n- [Contributing](#contributing)\n * [Reporting an Issue](#reporting-an-issue)\n * [Seeking for Help](#seeking-for-help)\n * [Contact](#contact)\n\n## Installation\n\nManim Slides requires either Manim or ManimGL to be installed, along\nwith their dependencies. Please checkout the\n[documentation](https://eertmans.be/manim-slides/latest/installation.html)\nfor detailed install instructions.\n\n## Usage\n\n<!-- start usage -->\n\nUsing Manim Slides is a two-step process:\n1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead\n of `Scene` (resp. `ThreeDScene`), and add calls to `self.next_slide()`\n every time you want to create a new slide.\n2. Run `manim-slides` on rendered animations and display them like a\n *PowerPoint* presentation.\n\nThe documentation is available [online](https://eertmans.be/manim-slides/).\n\n### Basic Example\n\nCall `self.next_slide()` every time you want to create a pause between\nanimations, and `self.next_slide(loop=True)` if you want the next slide to loop\nover animations until the user presses continue:\n\n```python\nfrom manim import * # or: from manimlib import *\n\nfrom manim_slides import Slide\n\n\nclass BasicExample(Slide):\n def construct(self):\n circle = Circle(radius=3, color=BLUE)\n dot = Dot()\n\n self.play(GrowFromCenter(circle))\n self.next_slide() # Waits user to press continue to go to the next slide\n\n self.next_slide(loop=True) # Start loop\n self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)\n self.next_slide() # This will start a new non-looping slide\n\n self.play(dot.animate.move_to(ORIGIN))\n```\n\nFirst, render the animation files:\n\n```bash\nmanim-slides render example.py BasicExample\n# or use ManimGL\nmanim-slides render --GL example.py BasicExample\n```\n<!-- end usage -->\n\n> **NOTE:**\n> Using `manim-slides render` makes sure to use the `manim`\n> (or `manimlib`) library that was installed in the same Python environment.\n> Put simply, this is a wrapper around\n> `manim render [ARGS]...` (or `manimgl [ARGS]...`).\n\n<!-- start more-usage -->\n\nTo start the presentation using `Scene1`, `Scene2` and so on, run:\n\n```bash\nmanim-slides [OPTIONS] Scene1 Scene2...\n```\n\nIn our example:\n\n```bash\nmanim-slides BasicExample\n```\n\n<!-- end more-usage -->\n\n<p align=\"center\">\n <img alt=\"Example GIF\" src=\"https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/example.gif\">\n</p>\n\nFor detailed usage documentation, run `manim-slides --help`, or go to the\n[documentation](https://eertmans.be/manim-slides/latest/reference/cli.html).\n\n## Interactive Tutorial\n\nClick on the image to watch a slides presentation that explains to you how\nto use Manim Slides.\n\n[](https://eertmans.be/manim-slides/)\n\n## More Examples\n\nMore examples are available in the\n[`example.py`](https://github.com/jeertmans/manim-slides/blob/main/example.py)\nfile, if you downloaded the git repository.\n\n## Comparison with Similar Tools\n\nThere exists a variety of tools that allows to create slides presentations\ncontaining Manim animations.\n\nBelow is a comparison of the most used ones with Manim Slides:\n\n| Project name | Manim Slides | Manim Presentation | Manim Editor | Jupyter Notebooks |\n|:------------:|:------------:|:------------------:|:------------:|:-----------------:|\n| Link | [](https://github.com/jeertmans/manim-slides) | [](https://github.com/galatolofederico/manim-presentation) | [](https://github.com/ManimCommunity/manim_editor) | [](https://github.com/jupyter/notebook) |\n| Activity | [](https://github.com/jeertmans/manim-slides) | [](https://github.com/galatolofederico/manim-presentation) | [](https://github.com/ManimCommunity/manim_editor) | [](https://github.com/jupyter/notebook) |\n| Usage | Command-line | Command-line | Web Browser | Notebook |\n| Note | Requires minimal modif. in scenes files | Requires minimal modif. in scenes files | Requires the usage of sections, and configuration through graphical interface | Relies on `nbconvert` to create slides from a Notebook |\n| Support for ManimGL | Yes | No | No | No |\n| Web Browser presentations | Yes | No | Yes | No |\n| Offline presentations | Yes, with Qt | Yes, with OpenCV | No | No\n\n## Citing\n\nIf you use this project, please cite it using the following reference:\n\n```bibtex\n@article{Jerome_Eertmans_Manim_Slides_A_2023,\n\ttitle = {{Manim Slides: A Python package for presenting Manim content anywhere}},\n\tauthor = {{J\u00e9rome Eertmans}},\n\tyear = 2023,\n\tmonth = aug,\n\tjournal = {Journal of Open Source Education},\n\tvolume = 6,\n\tdoi = {10.21105/jose.00206}\n}\n```\n\nor by linking this GitHub repository at the end of the presentation.\n\n## Contributing\n\nContributions are more than welcome! Please read through\n[our contributing section](https://eertmans.be/manim-slides/latest/contributing/index.html).\n\n### Reporting an Issue\n\n<!-- start reporting-an-issue -->\n\nIf you think you found a bug,\nan error in the documentation,\nor wish there was some feature that is currently missing,\nwe would love to hear from you!\n\nThe best way to reach us is via the\n[GitHub issues](https://github.com/jeertmans/manim-slides/issues).\nIf your problem is not covered by an already existing (closed or open) issue,\nthen we suggest you create a\n[new issue](https://github.com/jeertmans/manim-slides/issues/new/choose).\nYou can choose from a list of templates, or open a\n[blank issue](https://github.com/jeertmans/manim-slides/issues/new)\nif your issue does not fit one of the proposed topics.\n\nThe more precise you are in the description of your problem, the faster we will\nbe able to help you!\n\n<!-- end reporting-an-issue -->\n\n### Seeking for help\n\n<!-- start seeking-for-help -->\n\nSometimes, you may have a question about Manim Slides,\nnot necessarily an issue.\n\nFirst, make sure to read the\n[F.A.Q](https://eertmans.be/manim-slides/latest/faq.html) to see if\nyour question has already been answered. If not, please follow the\nrecommendation (from that page) to reach us for questions.\n\n<!-- end seeking-for-help -->\n\n### Contact\n\n<!-- start contact -->\n\nFinally, if you do not have any GitHub account,\nor just wish to contact the author of Manim Slides,\nyou can do so at: [jeertmans@icloud.com](mailto:jeertmans@icloud.com).\n\n<!-- end contact -->\n\n[pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides\n[pypi-version-url]: https://pypi.org/project/manim-slides/\n[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/manim-slides\n[pypi-download-badge]: https://img.shields.io/pypi/dm/manim-slides\n[documentation-badge]: https://readthedocs.org/projects/manim-slides/badge/?version=latest\n[documentation-url]: https://manim-slides.readthedocs.io/\n[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.8215167.svg\n[doi-url]: https://doi.org/10.5281/zenodo.8215167\n[jose-badge]: https://jose.theoj.org/papers/10.21105/jose.00206/status.svg\n[jose-url]: https://doi.org/10.21105/jose.00206\n[codecov-badge]: https://codecov.io/gh/jeertmans/manim-slides/branch/main/graph/badge.svg?token=8P4DY9JCE4\n[codecov-url]: https://codecov.io/gh/jeertmans/manim-slides\n[binder-badge]: https://mybinder.org/badge_logo.svg\n[binder-url]: https://mybinder.org/v2/gh/jeertmans/manim-slides-binder/HEAD?filepath=getting_started.ipynb\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool for live presentations using manim",
"version": "5.1.10",
"project_urls": {
"Changelog": "https://github.com/jeertmans/manim-slides/releases",
"Documentation": "https://eertmans.be/manim-slides",
"Founding": "https://github.com/sponsors/jeertmans",
"Homepage": "https://github.com/jeertmans/manim-slides",
"Repository": "https://github.com/jeertmans/manim-slides"
},
"split_keywords": [
"manim",
" manimgl",
" plugin",
" slides"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58802ed16d00081feac90d38a8cf2f0bb719a96362e98a164a4172cf3b2f951b",
"md5": "ffddfb07dc40cd9a4b0953e2f99fd755",
"sha256": "6483c6357a46b3384adb8feb76964bc108f5ab11a01c3fcf8833959fff47eae4"
},
"downloads": -1,
"filename": "manim_slides-5.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ffddfb07dc40cd9a4b0953e2f99fd755",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 61884,
"upload_time": "2024-12-03T11:58:47",
"upload_time_iso_8601": "2024-12-03T11:58:47.787113Z",
"url": "https://files.pythonhosted.org/packages/58/80/2ed16d00081feac90d38a8cf2f0bb719a96362e98a164a4172cf3b2f951b/manim_slides-5.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21277d5128b45f184a6b19e9b1d56765746b1f244b9c3def11759c3719733630",
"md5": "f7e9e29bd3f39590c3ec0c4e3fa70a50",
"sha256": "6ca8a5a98f6e18f4c5e416bb4133ea6e34aa741ae20199d40fd360c8fbafa3bf"
},
"downloads": -1,
"filename": "manim_slides-5.1.10.tar.gz",
"has_sig": false,
"md5_digest": "f7e9e29bd3f39590c3ec0c4e3fa70a50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1785051,
"upload_time": "2024-12-03T11:58:50",
"upload_time_iso_8601": "2024-12-03T11:58:50.289046Z",
"url": "https://files.pythonhosted.org/packages/21/27/7d5128b45f184a6b19e9b1d56765746b1f244b9c3def11759c3719733630/manim_slides-5.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 11:58:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeertmans",
"github_project": "manim-slides",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "manim-slides"
}
