Skip to main content

Programmatic animation engine for creating precise and smooth animations with real-time feedback

Project description

logo

MIT License PyPI Latest Release en Documentation Status

> English < | 简体中文

Introduction

JAnim is built around the core concept of programmatic animation to create precise and smooth animations. It supports real-time editing, live preview, and a wide range of other rich features.

Inspired by manim.

Introduction video: https://www.bilibili.com/video/BV17s42137SJ/

Examples

Highlights

Programmatic animation

class BubbleSort(Timeline):
    def construct(self):
        # define items
        heights = np.linspace(1.0, 6.0, 5)
        np.random.seed(123456)
        np.random.shuffle(heights)
        rects = [
            Rect(1, height,
                 fill_alpha=0.5)
            for height in heights
        ]

        group = Group(*rects)
        group.points.arrange(aligned_edge=DOWN)

        # do animations
        self.show(group)

        for i in range(len(heights) - 1, 0, -1):
            for j in range(i):
                rect1, rect2 = rects[j], rects[j + 1]

                self.play(
                    rect1.anim.color.set(BLUE),
                    rect2.anim.color.set(BLUE),
                    duration=0.15
                )

                if heights[j] > heights[j + 1]:
                    x1 = rect1.points.box.x
                    x2 = rect2.points.box.x

                    self.play(
                        rect1.anim.points.set_x(x2),
                        rect2.anim.points.set_x(x1),
                        duration=0.3
                    )

                    heights[[j, j + 1]] = heights[[j + 1, j]]
                    rects[j], rects[j + 1] = rect2, rect1

                self.play(
                    rect1.anim.color.set(WHITE),
                    rect2.anim.color.set(WHITE),
                    duration=0.15
                )

Change the code, refresh right away

Freely control the preview progress

Installation

JAnim runs on Python 3.12+

You may install JAnim directly via

pip install janim

to install the latest version distributed on PyPI.

To install the latest development version directly from the main branch without cloning the repository, you can run:

pip install git+https://github.com/jkjkil4/JAnim.git@main

Or, to catch up with the latest development and edit the source code, you may clone this repository and install it in editable mode:

git clone https://github.com/jkjkil4/JAnim.git
cd JAnim
pip install -e .

Using JAnim

You can run the following command to see examples.

janim examples

The Documentation provides a more detailed guide on installing and using JAnim. (Note: You can change the documentation language using the flyout menu at the corner of the page.)

License

MIT license

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

janim-4.2.0a1.tar.gz (377.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

janim-4.2.0a1-py3-none-any.whl (501.1 kB view details)

Uploaded Python 3

File details

Details for the file janim-4.2.0a1.tar.gz.

File metadata

  • Download URL: janim-4.2.0a1.tar.gz
  • Upload date:
  • Size: 377.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.34.0

File hashes

Hashes for janim-4.2.0a1.tar.gz
Algorithm Hash digest
SHA256 6c32de61e955c2dc3e274249b7b321b7b49913bbf75cb2e1c315b629a8a3d30a
MD5 318366e3046fda64b1abad3c894f03d7
BLAKE2b-256 73de19f531f0772c6cdae09fb21f1e7515ea97de23e67cb095471e58ae6de054

See more details on using hashes here.

File details

Details for the file janim-4.2.0a1-py3-none-any.whl.

File metadata

  • Download URL: janim-4.2.0a1-py3-none-any.whl
  • Upload date:
  • Size: 501.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.34.0

File hashes

Hashes for janim-4.2.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 36be41143a79e9a7946cac413bb56ffa0281d3c823a47337e750a69b3f4c0c33
MD5 26a98e084b39d2408d2b3b116da98a99
BLAKE2b-256 d78908c124986539e149463ce1e93a99cfef277010b0ccc4773ac61888f14d6f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page