Skip to content

Commit 7c12c61

Browse files
authored
Update README.md (#410)
1 parent 49ea3b5 commit 7c12c61

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![JET](https://img.shields.io/badge/%E2%9C%88%EF%B8%8F%20tested%20with%20-%20JET.jl%20-%20red)](https://github.com/aviatesk/JET.jl)
1010

1111

12-
**HarmonicBalance.jl** is a Julia package for solving periodic differential equations using the method of harmonic balance.
12+
**HarmonicBalance.jl** is a Julia package for solving periodic, nonlinear differential equations using the method of harmonic balance.
1313

1414
## Installation
1515

@@ -25,8 +25,8 @@ For a detailed description of the package and examples, see the [documentation](
2525

2626
[This repo](https://github.com/NonlinearOscillations/HarmonicBalance-notebooks) contains a collection of example notebooks.
2727

28-
## [Simple example](https://nonlinearoscillations.github.io/HarmonicBalance.jl/dev/tutorials/steady_states)
29-
Let's find the steady states of a driven Duffing oscillator with nonlinear damping, its equation of motion is:
28+
## [Example: steady states of a nonlinear resonator](https://nonlinearoscillations.github.io/HarmonicBalance.jl/dev/tutorials/steady_states)
29+
Let's find the steady states of a driven Duffing resonator with nonlinear damping, with equation of motion:
3030

3131
<img src="/docs/images/github_readme_eq.png" width="450">
3232

@@ -66,7 +66,22 @@ If you use HarmonicBalance.jl in your project, we kindly ask you to cite [this p
6666
Jan Košata, Javier del Pino, Toni L. Heugel, Oded Zilberberg
6767
SciPost Phys. Codebases 6 (2022)
6868

69-
## Similar software
69+
### BibTeX entry
70+
71+
```bibtex
72+
@Article{10.21468/SciPostPhysCodeb.6,
73+
title={{HarmonicBalance.jl: A Julia suite for nonlinear dynamics using harmonic balance}},
74+
author={Jan Košata and Javier del Pino and Toni L. Heugel and Oded Zilberberg},
75+
journal={SciPost Phys. Codebases},
76+
pages={6},
77+
year={2022},
78+
publisher={SciPost},
79+
doi={10.21468/SciPostPhysCodeb.6},
80+
url={https://scipost.org/10.21468/SciPostPhysCodeb.6}
81+
}
82+
```
83+
84+
## See also
7085

71-
- [JosephsonCircuits.jl](https://github.com/kpobrien/JosephsonCircuits.jl): Performs the frequency domain behaviour with a similar Harmonic Balance method for nonlinear circuits containing Josephson junctions, capacitors, inductors, mutual inductors, and resistors.
86+
- [JosephsonCircuits.jl](https://github.com/kpobrien/JosephsonCircuits.jl): Models superconducting circuits using modified nodal analysis and harmonic balance with an analytic Jacobian.
7287
- [Manlab](https://manlab.lma.cnrs-mrs.fr/spip/): A similar package in Matlab also using continuation methods and using the Harmonic Balance method for periodic orbits.

0 commit comments

Comments
 (0)