manim-physics

manim-physics is a 2D physics simulation plugin for Manim. It is designed to allow users to generate complex scenes across various physics domains, including:

• Rigid mechanics
• Electromagnetism
• Wave physics

For more detailed information, refer to the Official Documentation.

The manim_physics package provides modules for simulating electromagnetism. The available submodules are:

• manim_physics.electromagnetism.electrostatics: For simulating electrostatic phenomena.
• manim_physics.electromagnetism.magnetostatics: For simulating magnetostatic phenomena.

The manim_physics.rigid_mechanics module provides tools for simulating rigid body mechanics within Manim. The primary components available for use are:

• rigid_mechanics: The core module for managing rigid body simulations.
• pendulum: A specialized component for simulating pendulum motion.

Detailed API references for these components can be found in the project's reference documentation.

The manim_physics optics module provides tools for simulating light behavior, specifically through lenses and ray tracing. The module is organized into two primary sub-modules:

• manim_physics.optics.lenses: Contains classes and functions for simulating various types of optical lenses.
• manim_physics.optics.rays: Contains tools for simulating light rays and their interactions with optical elements.

Install the manim-physics package directly from PyPI using pip.

Warning: Do not clone the GitHub repository directly for use, as the repository is under active development and may not be stable. Always use the PyPI package for a stable version.

pip install manim-physics

To use the physics features in your Manim animation files, include the following import statement at the top of your Python file:

from manim_physics import *

The manim_physics package acts as a central entrypoint that re-exports various physics-related modules for use within Manim animations. Instead of importing from submodules individually, you can import the entire physics suite directly from manim_physics.

Available physics domains included in the package:

• Electromagnetism: Electrostatics and Magnetostatics.
• Optics: Lenses and Rays.
• Rigid Mechanics: Pendulums and general Rigid Mechanics.
• Waves: Wave physics components.

from manim_physics import *

# Now you can use classes from:
# .electromagnetism.electrostatics
# .electromagnetism.magnetostatics
# .optics.lenses
# .optics.rays
# .rigid_mechanics.pendulum
# .rigid_mechanics.rigid_mechanics
# .wave

The StandingWave class creates a 2D wave (represented as a ParametricFunction) that oscillates in place, simulating a standing wave pattern.

Parameters:

• n (int): The harmonic number.
• length (float): The total length of the wave.
• period (float): The time taken for one full oscillation.
• amplitude (float): The maximum height of the wave.
• **kwargs: Additional parameters passed to the Manim ParametricFunction class.

Animation Control:

• start_wave(): Begins the standing wave oscillation.
• stop_wave(): Stops the standing wave oscillation.

# Example: Creating multiple harmonics
wave1 = StandingWave(n=1, length=4, amplitude=1)
wave2 = StandingWave(n=2, length=4, amplitude=1)

waves = VGroup(wave1, wave2)
da.add(waves)
for wave in waves:
    wave.start_wave()
self.wait()