Skip to content

Commit e8e97e3

Browse files
committed
Update documentation
1 parent 58c38e2 commit e8e97e3

3 files changed

Lines changed: 20 additions & 24 deletions

File tree

docs/source/examples.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ Below are various example scripts from the ``TransientBVD/examples`` directory,
55
demonstrating how to use TransientBVD in different scenarios. Each snippet is
66
embedded here for convenient reference.
77

8-
98
Basic Example
109
-------------
1110
A minimal script showing how to import TransientBVD and call a simple method.
@@ -22,35 +21,36 @@ Demonstrates creating a predefined transducer object and using library methods.
2221
:language: python
2322
:linenos:
2423

25-
Decay Time Example
26-
------------------
27-
Shows how to compute decay time (τ) in different conditions.
24+
Deactivation Time Example
25+
-------------------------------
26+
Shows how to compute deactivation time (τ) in different conditions for deactivation.
2827

29-
.. literalinclude:: ../../examples/decay_time_example.py
28+
.. literalinclude:: ../../examples/deactivation_time_example.py
3029
:language: python
3130
:linenos:
3231

33-
Decay Time Over Rp Example
34-
--------------------------
35-
Explores how decay time changes over various parallel resistance values (Rp).
32+
Deactivation Time Over Rp Example
33+
----------------------------------------
34+
Explores how deactivation time changes over various parallel resistance values (Rp)
35+
in the deactivation scenario.
3636

37-
.. literalinclude:: ../../examples/decay_time_over_rp_example.py
37+
.. literalinclude:: ../../examples/deactivation_time_over_rp_example.py
3838
:language: python
3939
:linenos:
4040

4141
Optimum Resistance Example
4242
--------------------------
43-
Uses the library’s optimization routine to find the best Rp for minimal decay.
43+
Uses the library’s optimization routine to find the best Rp for minimal deactivation time.
4444

4545
.. literalinclude:: ../../examples/optimum_resistance_example.py
4646
:language: python
4747
:linenos:
4848

49-
Plot Closed Current Example
50-
---------------------------
51-
Plots the transient current response under a closed-circuit with overboost.
49+
Plot Activation Current Example
50+
-------------------------------
51+
Plots the transient current response under an activation scenario with overboost.
5252

53-
.. literalinclude:: ../../examples/plot_closed_current_example.py
53+
.. literalinclude:: ../../examples/activation_current_plot_example.py
5454
:language: python
5555
:linenos:
5656

@@ -68,4 +68,4 @@ Showcases how to capture and save computation results (e.g., to CSV or JSON).
6868

6969
.. literalinclude:: ../../examples/results_saving_example.py
7070
:language: python
71-
:linenos:
71+
:linenos:

docs/source/index.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TransientBVD — Transient Response Analysis
77
**TransientBVD** is a Python library for analyzing and optimizing the transient
88
response of ultrasound transducers (or other resonant systems) modeled by the
99
Butterworth-Van Dyke (BVD) equivalent circuit. It implements advanced methods
10-
for both open-circuit (resistive damping) and closed-circuit (voltage overboost)
10+
for both deactivation (resistive damping) and activation (voltage overboost)
1111
strategies, significantly reducing transient response times.
1212

1313
This library is developed at the
@@ -42,9 +42,9 @@ If you find **TransientBVD** helpful in your own research, please cite:
4242

4343
.. code-block:: bibtex
4444
45-
@article{doersamSuppeltKupnik2024,
45+
@article{doersamTransientBVD2024,
4646
title = {Rapid Transient Control Strategies for Ultrasound Transducers},
47-
author = {Dörsam, Jan Helge and Suppelt, Sven and Kupnik, Mario},
47+
author = 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, Soeren and Heyl, Christoph and Kupnik, Mario},
4848
journal = {IEEE TRANSACTIONS ON ULTRASONICS, FERROELECTRICS, AND FREQUENCY CONTROL},
4949
year = {2025},
5050
volume = {??},
@@ -73,12 +73,8 @@ This work was supported through multiple grants and collaborations:
7373
funding by Austria, Belgium, Czech Republic, Germany, Netherlands, Norway,
7474
and Spain).
7575

76-
77-
7876
Indices and tables
7977
------------------
8078
* :ref:`genindex`
8179
* :ref:`modindex`
8280
* :ref:`search`
83-
84-

docs/source/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Use Poetry or pip. Example (pip):
1212
1313
Basic Example
1414
-------------
15-
Using open-circuit potential analysis:
15+
Using deactivation potential analysis:
1616

1717
.. code-block:: python
1818
@@ -25,7 +25,7 @@ Using open-circuit potential analysis:
2525
c0=3970.1e-12
2626
)
2727
28-
Closed-circuit potential with overboost:
28+
Activation potential with overboost:
2929

3030
.. code-block:: python
3131

0 commit comments

Comments
 (0)