Skip to main content

A manim-plugin that adds custom circuit VMobject(s)

Project description

Manim-Circuit Plugin

Description

A manim-plugin that adds customized Mobject and VMobject(s) to create some electrical components. Some electrical components include: Resistors, Inductors, and Capacitors.

Ok... But WHY?

Manim is an animation library for mathematics. So... what am I doing over here, making some basic circuit elements in the form of customized Mobjects? Well, as it turns out, much of circuit analysis has some pretty cool mathematics behind it, and so I wished that there was a library that could give me those customized Mobjects. I am making this library alongside the production of my Practical Engineering series on YouTube.

"airight man, but you do know that other libraries exist, you know... CircuiTikz via LaTex, circuitanimlib for ManimGL just to name a few... Stop insisting on re-inventing the wheel".

Alright, let's talk about CircuiTikz. I am fully aware that this wonderful LaTex package exists. You can choose to use CircuitTikz to render the circuit, but you cannot select components of that Tex Mobject like you would when using this manim-plugin. Also, I saw a few bugs on forums relating manim and CircuitTikz together, on other GitHub repositories.CircuitTikz is great at making PDFs, drawing circuit diagrams in papers, but it just simply does not fit nicely with Manim.

And for circuitanimlib, the library seemed promising, until I realized its latest commit renders it broken, and its unmaintained. Also, it uses ManimGL which, although faster, has limited documentation on it.

This library is written for ManimCE, not ManimGL. Additionally, there are more resrouces for ManimCE as opposed to ManimGL. Additionally still, ManimCE even has a nice plugin repository and active community plugins. I'd like to make a contribution onto it!

Inspiration

Why I made this library

Roadmap

  • Make this my first open-source package that I, FuzzyPenguin (online alias: Pete Aptenodyte Forsteri) will maintain.
  • Release this to Pypi
  • Make this a manim-plugin named manim-circuit
  • Add all of the circuit elements that were used in our class
  • Use this library for AT LEAST one of my future videos whatever it may be*
  • Clean up the Code
  • Maybe make a Circuit Mobject in order to help with circuit analysis
  • If I have time, make logic gates too

*Most likely Circuit Analysis using Laplace Transform for a pure Manim-based animation video

Documentation

Please note, this is a WIP: More things will be added as Development continues. Resistor(), Inductor(), Capacitor(), supports labels. For example: Inductor(label="0.3", direction=UP) will make a 0.3 H inductor with a label on the top.

All customized Mobjects will have a .get_terminals(self, val) method where passing something in val will return the coordinate of a pin of any circuit Element.

Examples in examples/

License

MIT

Project details


Download files

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

Source Distribution

manim_circuit-0.0.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

manim_circuit-0.0.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file manim_circuit-0.0.2.tar.gz.

File metadata

  • Download URL: manim_circuit-0.0.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.10-arch1-1

File hashes

Hashes for manim_circuit-0.0.2.tar.gz
Algorithm Hash digest
SHA256 5f0d5015c67adfd745f90e981c19a5bfb0cb8e93bb2bd0e16b6f958fe339ca97
MD5 1b895c52e3da16c58b602052925a962e
BLAKE2b-256 f0ad3bc9c4a96261e64bc94ab51ddcab39165c230698a8f3ed9a65cf5dbd5824

See more details on using hashes here.

File details

Details for the file manim_circuit-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: manim_circuit-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.10-arch1-1

File hashes

Hashes for manim_circuit-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3b68446bc8aae4786f5c848d481f733826f1287007a8881f04fe551559ad4b99
MD5 5c6ae8fb485311e1778e25ade65ff8ae
BLAKE2b-256 56ee3d8046df5e3d8484b7dc81d3432423f43e51653d83349937ba09eebebd2b

See more details on using hashes here.

Supported by

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