Skip to main content

Library for analysing and calculating electric networks.

Project description

CircuitCalculator

CircuitCalculator is a Python library for symbolic and numeric analysis of electrical circuits. It supports DC and AC analysis, nodal analysis, state-space modeling, and works with both numeric and symbolic component values. The library is designed for engineers, students, and researchers who want to analyze, simulate, or teach circuit theory using Python.

Features

  • Symbolic and numeric circuit analysis
  • Support for resistors, capacitors, inductors, voltage sources, and current sources
  • Nodal analysis and state-space modeling
  • Easy-to-use API for building and solving circuits
  • Integration with Jupyter/IPython notebooks for interactive exploration

Installation

You can install CircuitCalculator and its dependencies using pip (e.g. in a virtual environment):

python -m venv ./venv
source ./venv/bin activate
pip install CircuitCalculator

Usage

The most convenient interface is the Circuit class, which allows you to define a circuit as a list of components and then solve it. Below is a minimal example for DC analysis:

Example

from CircuitCalculator.Circuit.circuit import Circuit
import CircuitCalculator.Circuit.Components.components as ccp
from CircuitCalculator.Circuit.solution import dc_solution

# Define the circuit
circuit = Circuit([
    ccp.dc_voltage_source(V=1, id='Vs', nodes=('1', '0')),
    ccp.resistor(R=1, id='R', nodes=('1', '0'))
])

# Solve the circuit
solution = dc_solution(circuit)
print(f'I(R)={solution.get_current("R"):2.2f}A')
print(f'V(R)={solution.get_voltage("R"):2.2f}V')

Output:

I(R)=1.00A
V(R)=1.00V

Examples

Several Jupyter/IPython notebook examples can be found in the examples directory.

Contribution

This project is open-source and contributions are welcome. If you would like to contribute, please fork the repository and make a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or issues, please open an issue on the GitHub repository.

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

circuitcalculator-0.4.21.tar.gz (53.3 kB view details)

Uploaded Source

Built Distribution

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

circuitcalculator-0.4.21-py3-none-any.whl (73.2 kB view details)

Uploaded Python 3

File details

Details for the file circuitcalculator-0.4.21.tar.gz.

File metadata

  • Download URL: circuitcalculator-0.4.21.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for circuitcalculator-0.4.21.tar.gz
Algorithm Hash digest
SHA256 dba1b66ad77ecfff2eab6a1dc1be1f377fb51051d5ab74a662ee5cc780b1cf5f
MD5 2d38f8f3c3cca171ba65ed4a614905ef
BLAKE2b-256 fce64f61861b90b94a6a8845dbff880d48bd2c7295d7aba6b7e32926f9191ae7

See more details on using hashes here.

File details

Details for the file circuitcalculator-0.4.21-py3-none-any.whl.

File metadata

File hashes

Hashes for circuitcalculator-0.4.21-py3-none-any.whl
Algorithm Hash digest
SHA256 6b82b3c4862110b971ccf43a651695c4b486d4d1d27043ed8bf8dd8d3517039d
MD5 4abf8a103a2307d0b3bf8a69545e2e25
BLAKE2b-256 1ba9471a5e5f1eab5b54c05c9de6d946b384cceaa64a0de9ec718218e29327aa

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