Skip to main content

svg schematics

Project description

Author:

Ken Kundert

Version:
1.0.0
Released:

2020-04-16

This package allows you to create simple SVG schematics and block diagrams without a mouse. Instead, you build the schematic using Python to instantiate and place the symbols and wires.

Simple Example

Here is a simple example that demonstrates the package. It generates the schematic of a shunt RLC circuit:

from svg_schematic import Schematic, Resistor, Capacitor, Inductor, Wire
from inform import Error, error, os_error

try:
    with Schematic(filename='rlc.svg'):
        r = Resistor(name='R', orient='v')
        c = Capacitor(W=r.E, name='C', orient='v')
        l = Inductor(W=c.E, name='L', orient='v|')
        Wire([r.p, l.p])
        Wire([r.n, l.n])
except Error as e:
    e.report()
except OSError as e:
    error(os_error(e))

When run, it produces the following schematic:

doc/images/Golden/rlc.svg

Installation

Requires Python3. Works best with Python3.6 or newer.

You can download and install the latest stable version of the code from PyPI using:

pip3 install --user svg_schematic

You can find the latest development version of the source code on Github.

Documentation

You can find documentation at ReadTheDocs.

Issues

Please ask questions or report problems on Github Issues.

Contributions

Contributions in the form of pull requests are welcome.

I tend to create symbols as I need them. If you create missing symbols, please consider contributing them back to the project.

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

svg_schematic-1.0.0.tar.gz (13.6 kB view details)

Uploaded Source

File details

Details for the file svg_schematic-1.0.0.tar.gz.

File metadata

  • Download URL: svg_schematic-1.0.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.7.6

File hashes

Hashes for svg_schematic-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8c7975cb1151e98c99265b8b8182092a1c86e8244f31d38f3ed3c0e056717bda
MD5 c32e5d5b1e26b19476f6320ec400bb38
BLAKE2b-256 207d71f86f22ebe42bc9951229794fa113ac8b6d77a6a033a55fbed3556f883e

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