Metadata-Version: 2.4
Name: transientbvd
Version: 1.0.0
Summary: A Python library for transient response analysis and optimization using the Butterworth-Van Dyke (BVD) equivalent circuit model.
License: MIT
License-File: LICENSE
Keywords: activation,BVD,deactivation,transient response,rapid,analysis,optimization,Butterworth-Van Dyke,circuit,ultrasound,transducer,ultrasonic,step response,ring-down
Author: Jan Helge Döersam
Author-email: jan_helge.doersam@tu-darmstadt.de
Maintainer: Jan Helge Dörsam
Maintainer-email: jan_helge.doersam@tu-darmstadt.de
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: pandas (>=2.2,<4.0)
Requires-Dist: scipy (>=1.14,<2.0)
Requires-Dist: sympy (>=1.14,<2.0)
Project-URL: Documentation, https://transientbvd.readthedocs.io/
Project-URL: Homepage, https://github.com/TUDA-MUST/TransientBVD
Project-URL: Repository, https://github.com/TUDA-MUST/TransientBVD
Description-Content-Type: text/markdown

# TransientBVD
[![PyPI](https://img.shields.io/pypi/v/transientbvd?style=flat-square)](https://pypi.org/project/transientbvd/)
[![Documentation Status](https://readthedocs.org/projects/transientbvd/badge/?version=latest&style=flat-square)](https://transientbvd.readthedocs.io/en/latest/)
![Tests](https://github.com/TUDA-MUST/TransientBVD/actions/workflows/tests.yml/badge.svg)
![Pylint](https://github.com/TUDA-MUST/TransientBVD/actions/workflows/pylint.yml/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![DOI](https://img.shields.io/badge/10.1109/OJUFFC.2026.3673287-blue.svg?style=flat-square)](https://doi.org/10.1109/OJUFFC.2026.3673287)

**TransientBVD** is a Python library for analyzing and optimizing the transient response of ultrasonic transducers (or other resonant systems) modeled by the Butterworth-Van Dyke (BVD) equivalent circuit. It implements advanced methods for both **deactivation** (resistive damping) and **activation** (voltage overboost) strategies, significantly reducing transient response times.

## Features

- **Deactivation damping**: Quickly compute an optimal parallel resistor \(R_p\) to minimize deactivation transient response times.
- **Activation overboost**: Determine switching strategies (e.g. voltage amplitude changes) to reduce activation transient response times.
- **Comprehensive analysis**: Includes handy methods like `print_deactivation_potential` and `print_activation_potential` for quick insights.
- **Transducer utility**: Load already measured example transducers or define your own BVD parameters.
- **Integration**: Built on Python (NumPy, SciPy, Sympy) for both symbolic and numeric calculations.

## Documentation

For detailed usage instructions, examples, and API references, visit the 
[**TransientBVD Documentation**](https://transientbvd.readthedocs.io/en/latest/).

## Research Context

Developed at the 
[Measurement and Sensor Technology Group, TU Darmstadt](https://www.etit.tu-darmstadt.de/must/home_must/index.en.jsp),
this library supports the research findings presented in:

> **"Rapid Transient Control Strategies for Air-Coupled Ultrasonic Transducers"**
> 
> Status: Published
> 
> DOI: [10.1109/OJUFFC.2026.3673287](https://doi.org/10.1109/OJUFFC.2026.3673287)


If you find **TransientBVD** helpful in your academic work, please cite:

```bibtex
@article{doersamTransientBVD2026,
  title   = {Rapid Transient Control Strategies for Air-Coupled Ultrasonic Transducers},
  author  = {Dörsam, Jan H. and Suppelt, Sven and Kleber, Carsten and Altmann, Alexander A. and Schrödel, Yannick and Schmitt, Daniel and Schmitt, Toni and Haugwitz, Christoph and Wismath, Sonja and Soennecken, Sören and Heyl, Christoph M. and Kupnik, Mario},
  journal = {IEEE Open Journal of Ultrasonics, Ferroelectrics, and Frequency Control},
  year    = {2026},
  month   = mar,
  volume  = {6},
  pages   = {68--79},
  doi     = {10.1109/OJUFFC.2026.3673287},
}

