Merge pull request #20 from pedrohnv/release-0.2.0

Release 0.2.0
pedrohnv · Oct 8, 2024 · 8e0ec87 · 8e0ec87 · pedrohnv · Oct 8, 2024
2 parents 0fc3b08 + 7031028
commit 8e0ec87
Show file tree

Hide file tree

Showing 14 changed files with 1,034 additions and 644 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -9,5 +9,8 @@
     },
     "MD033": false,
     "MD041": false,
-    "default": true
+    "default": true,
+    "no-duplicate-heading": {
+        "siblings_only": true
+    }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,9 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2024-10-08
+
 ### Added
 
 - weighting to the least-square problem, so that some ranges have a "priority" to fit.
+- Examples 1-4 to the docs
+
+### Fixed
+
+- minimum Julia version is v1.10
 
 ## [0.1.1] - 2024-10-07
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -32,4 +32,4 @@ abstract: >-
   programming language
 keywords:
   - vector fitting
-license: GPL-2.0-or-later
+license: GPL-3.0-or-later
diff --git a/LICENSE b/LICENSE
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "RationalVectorFitting"
 uuid = "52b1e31a-230f-50d6-be04-0f5494ddfff6"
 authors = ["Pedro H. N. Vieira <phnvieira@proton.me>"]
-version = "0.1.1"
+version = "0.2.0"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

diff --git a/README.md b/README.md
@@ -12,7 +12,9 @@ The transfer function can be a vector $f(s) = \[y_1, \dots, y_m\]$ and the Vecto
 
 A rational representation of a transfer function makes it easier to find a [state space canonical realization](https://en.wikipedia.org/wiki/Realization_(systems)#Canonical_realizations) of a system and to [perform convolutions](https://doi.org/10.4236/jamp.2022.106144).
 
-## Usage Example
+## Example
+
+[Read the docs for more examples.](https://pedrohnv.github.io/RationalVectorFitting.jl/stable/)
 
 ```julia
 using RationalVectorFitting
@@ -36,13 +38,7 @@ begin
 end
 ```
 
-## References
-
-[1] B. Gustavsen and A. Semlyen, "Rational approximation of frequency domain responses by vector fitting," in IEEE Transactions on Power Delivery, vol. 14, no. 3, pp. 1052-1061, July 1999, [doi: 10.1109/61.772353](https://doi.org/10.1109/61.772353).
-
-[2] B. Gustavsen, "Improving the pole relocating properties of vector fitting," in IEEE Transactions on Power Delivery, vol. 21, no. 3, pp. 1587-1592, July 2006, [doi: 10.1109/TPWRD.2005.860281](https://doi.org/10.1109/TPWRD.2005.860281).
-
-[3] D. Deschrijver, M. Mrozowski, T. Dhaene and D. De Zutter, "Macromodeling of Multiport Systems Using a Fast Implementation of the Vector Fitting Method," in IEEE Microwave and Wireless Components Letters, vol. 18, no. 6, pp. 383-385, June 2008, [doi: 10.1109/LMWC.2008.922585](https://doi.org/10.1109/LMWC.2008.922585).
+---
 
 [![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://pedrohnv.github.io/RationalVectorFitting.jl/stable)
 [![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://pedrohnv.github.io/RationalVectorFitting.jl/dev)
@@ -77,3 +73,13 @@ If you want to make contributions of any kind, please first that a look into our
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
+
+## Bibliography
+
+[1] B. Gustavsen and A. Semlyen, "Rational approximation of frequency domain responses by vector fitting," in IEEE Transactions on Power Delivery, vol. 14, no. 3, pp. 1052-1061, July 1999, [doi: 10.1109/61.772353](https://doi.org/10.1109/61.772353).
+
+[2] B. Gustavsen, "Improving the pole relocating properties of vector fitting," in IEEE Transactions on Power Delivery, vol. 21, no. 3, pp. 1587-1592, July 2006, [doi: 10.1109/TPWRD.2005.860281](https://doi.org/10.1109/TPWRD.2005.860281).
+
+[3] D. Deschrijver, M. Mrozowski, T. Dhaene and D. De Zutter, "Macromodeling of Multiport Systems Using a Fast Implementation of the Vector Fitting Method," in IEEE Microwave and Wireless Components Letters, vol. 18, no. 6, pp. 383-385, June 2008, [doi: 10.1109/LMWC.2008.922585](https://doi.org/10.1109/LMWC.2008.922585).
+
+[4] A. M. Smith, S. D'Arco, J. A. Suul and B. Gustavsen, "Improved Pole Placement and Compaction of MIMO Vector Fitting Applied to System Identification," in IEEE Transactions on Power Delivery, vol. 39, no. 2, pp. 1259-1270, April 2024, [doi: 10.1109/TPWRD.2024.3364836.](https://doi.org/10.1109/TPWRD.2024.3364836)
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,10 +1,8 @@
-# Don't forget to run
-#
-#     pkg> dev ..
-#
 [deps]
+DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 RationalVectorFitting = "52b1e31a-230f-50d6-be04-0f5494ddfff6"
 
 [compat]

diff --git a/docs/src/examples/03PK10.txt → docs/src/03PK10.txt b/docs/src/examples/03PK10.txt → docs/src/03PK10.txt
diff --git a/docs/src/examples/ex1.md b/docs/src/examples/ex1.md
diff --git a/docs/src/examples/ex2.md b/docs/src/examples/ex2.md
diff --git a/docs/src/examples/ex3.md b/docs/src/examples/ex3.md
diff --git a/docs/src/examples/ex4.md b/docs/src/examples/ex4.md
diff --git a/docs/src/examples/fdne.txt → docs/src/fdne.txt b/docs/src/examples/fdne.txt → docs/src/fdne.txt