Merge pull request #7 from pedrohnv/development

Change package name and add meaningful description

.copier-answers.yml

@@ -6,7 +6,7 @@ Indentation: 4
 JuliaMinVersion: '1.6'
 License: GPL-3.0
 LicenseCopyrightHolders: Pedro H. N. Vieira
-PackageName: VectorFitting
+PackageName: RationalVectorFitting
 PackageOwner: pedrohnv
 PackageUUID: 52b1e31a-230f-50d6-be04-0f5494ddfff6
 _commit: v0.10.1

.github/ISSUE_TEMPLATE/10-bug-report.yml

@@ -10,12 +10,12 @@ body:
 
               Please, before submitting, make sure that:
 
-              - There is not an [existing issue](https://github.com/pedrohnv/VectorFitting.jl/issues) with the same question
+              - There is not an [existing issue](https://github.com/pedrohnv/RationalVectorFitting.jl/issues) with the same question
 
-              - You have read the [contributing guide](https://pedrohnv.github.io/VectorFitting.jl/dev/90-contributing/)
+              - You have read the [contributing guide](https://pedrohnv.github.io/RationalVectorFitting.jl/dev/90-contributing/)
 
 
-              - You are following the [code of conduct](https://github.com/pedrohnv/VectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
+              - You are following the [code of conduct](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
 
 
               The form below should help you in filling out this issue.

.github/ISSUE_TEMPLATE/20-feature-request.yml

@@ -8,12 +8,12 @@ body:
 
               Please, before submitting, make sure that:
 
-              - There is not an [existing issue](https://github.com/pedrohnv/VectorFitting.jl/issues) with the same question
+              - There is not an [existing issue](https://github.com/pedrohnv/RationalVectorFitting.jl/issues) with the same question
 
-              - You have read the [contributing guide](https://pedrohnv.github.io/VectorFitting.jl/dev/90-contributing/)
+              - You have read the [contributing guide](https://pedrohnv.github.io/RationalVectorFitting.jl/dev/90-contributing/)
 
 
-              - You are following the [code of conduct](https://github.com/pedrohnv/VectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
+              - You are following the [code of conduct](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
 
 
               The form below should help you in filling out this issue.

.github/ISSUE_TEMPLATE/30-usage.yml

@@ -9,13 +9,13 @@ body:
 
               Please, before submitting, make sure that:
 
-              - You have checked the [documentation](https://pedrohnv.github.io/VectorFitting.jl) and haven't found enough information
-              - There is not an [existing issue](https://github.com/pedrohnv/VectorFitting.jl/issues) with the same question
+              - You have checked the [documentation](https://pedrohnv.github.io/RationalVectorFitting.jl) and haven't found enough information
+              - There is not an [existing issue](https://github.com/pedrohnv/RationalVectorFitting.jl/issues) with the same question
 
-              - You have read the [contributing guide](https://pedrohnv.github.io/VectorFitting.jl/dev/90-contributing/)
+              - You have read the [contributing guide](https://pedrohnv.github.io/RationalVectorFitting.jl/dev/90-contributing/)
 
 
-              - You are following the [code of conduct](https://github.com/pedrohnv/VectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
+              - You are following the [code of conduct](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
 
 
               The form below should help you in filling out this issue.

.github/ISSUE_TEMPLATE/99-general.yml

@@ -8,12 +8,12 @@ body:
 
               Please, before submitting, make sure that:
 
-              - There is not an [existing issue](https://github.com/pedrohnv/VectorFitting.jl/issues) with the same question
+              - There is not an [existing issue](https://github.com/pedrohnv/RationalVectorFitting.jl/issues) with the same question
 
-              - You have read the [contributing guide](https://pedrohnv.github.io/VectorFitting.jl/dev/90-contributing/)
+              - You have read the [contributing guide](https://pedrohnv.github.io/RationalVectorFitting.jl/dev/90-contributing/)
 
 
-              - You are following the [code of conduct](https://github.com/pedrohnv/VectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
+              - You are following the [code of conduct](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/CODE_OF_CONDUCT.md)
 
 
               The form below should help you in filling out this issue.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
     - name: Discussions
-      url: https://github.com/pedrohnv/VectorFitting.jl/discussions
+      url: https://github.com/pedrohnv/RationalVectorFitting.jl/discussions
       about: Create and follow discussions here

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,5 @@
 <!--
-Thanks for making a pull request to VectorFitting.jl.
+Thanks for making a pull request to RationalVectorFitting.jl.
 We have added this PR template to help you help us.
 
 Make sure to read the contributing guidelines and abide by the code of conduct.
@@ -24,7 +24,7 @@ There is no related issue.
 <!-- mark true if NA -->
 <!-- leave PR as draft until all is checked -->
 
-- [ ] I am following the [contributing guidelines](https://github.com/pedrohnv/VectorFitting.jl/blob/main/docs/src/90-contributing.md)
+- [ ] I am following the [contributing guidelines](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/docs/src/90-contributing.md)
 
 - [ ] Tests are passing
 - [ ] Lint workflow is passing

.github/workflows/Docs.yml

@@ -43,9 +43,9 @@ jobs:
             - run: |
                   julia --project=docs -e '
                     using Documenter: DocMeta, doctest
-                    using VectorFitting
-                    DocMeta.setdocmeta!(VectorFitting, :DocTestSetup, :(using VectorFitting); recursive=true)
-                    doctest(VectorFitting)'
+                    using RationalVectorFitting
+                    DocMeta.setdocmeta!(RationalVectorFitting, :DocTestSetup, :(using RationalVectorFitting); recursive=true)
+                    doctest(RationalVectorFitting)'
             - run: julia --project=docs docs/make.jl
               env:
                   JULIA_PKG_SERVER: ""

.lychee.toml

@@ -2,7 +2,7 @@ exclude = [
   "@ref",
   "^https://github.com/.*/releases/tag/v.*$",
   "^https://doi.org/FIXME$",
-  "^https://pedrohnv.github.io/VectorFitting.jl/stable$",
+  "^https://pedrohnv.github.io/RationalVectorFitting.jl/stable$",
   "zenodo.org/badge/DOI/FIXME$"
 ]
 

README.md

@@ -1,7 +1,17 @@
-# VectorFitting
+# RationalVectorFitting
 
 Fast Relaxed Vector Fitting implementation in Julia.
 
+Given a transfer function $f(s) = y$, the Vector Fitting algorithm tries to find a rational approximation
+
+$$f(s) \approx \sum_{n=1}^N \frac{r_n}{s - a_n} + d + s\,h$$
+
+where $s$ is the complex frequency, $r_n$ are the complex residues, $a_n$ are the complex poles, $d$ and $h$ are real constants.
+
+The transfer function can be a vector $f(s) = \[y_1, \dots, y_m\]$ and the Vector Fitting algorithm will fit the response using the same set of poles $a_n$ for all $y_m$.
+
+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).
+
 ## 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).
@@ -10,25 +20,25 @@ Fast Relaxed Vector Fitting implementation in Julia.
 
 [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/VectorFitting.jl/stable)
-[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://pedrohnv.github.io/VectorFitting.jl/dev)
-[![Build Status](https://github.com/pedrohnv/VectorFitting.jl/workflows/Test/badge.svg)](https://github.com/pedrohnv/VectorFitting.jl/actions)
-[![Test workflow status](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Test.yml?query=branch%3Amain)
-[![Lint workflow Status](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Lint.yml?query=branch%3Amain)
-[![Docs workflow Status](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/pedrohnv/VectorFitting.jl/actions/workflows/Docs.yml?query=branch%3Amain)
+[![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)
+[![Build Status](https://github.com/pedrohnv/RationalVectorFitting.jl/workflows/Test/badge.svg)](https://github.com/pedrohnv/RationalVectorFitting.jl/actions)
+[![Test workflow status](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Test.yml?query=branch%3Amain)
+[![Lint workflow Status](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Lint.yml?query=branch%3Amain)
+[![Docs workflow Status](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/pedrohnv/RationalVectorFitting.jl/actions/workflows/Docs.yml?query=branch%3Amain)
 
-[![Coverage](https://codecov.io/gh/pedrohnv/VectorFitting.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pedrohnv/VectorFitting.jl)
+[![Coverage](https://codecov.io/gh/pedrohnv/RationalVectorFitting.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pedrohnv/RationalVectorFitting.jl)
 [![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
-[![All Contributors](https://img.shields.io/github/all-contributors/pedrohnv/VectorFitting.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/github/all-contributors/pedrohnv/RationalVectorFitting.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors)
 
 ## How to Cite
 
-If you use VectorFitting.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/pedrohnv/VectorFitting.jl/blob/main/CITATION.cff).
+If you use RationalVectorFitting.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/pedrohnv/RationalVectorFitting.jl/blob/main/CITATION.cff).
 
 ## Contributing
 
-If you want to make contributions of any kind, please first that a look into our [contributing guide directly on GitHub](docs/src/90-contributing.md) or the [contributing page on the website](https://pedrohnv.github.io/VectorFitting.jl/dev/90-contributing/).
+If you want to make contributions of any kind, please first that a look into our [contributing guide directly on GitHub](docs/src/90-contributing.md) or the [contributing page on the website](https://pedrohnv.github.io/RationalVectorFitting.jl/dev/90-contributing/).
 
 ---
 

docs/make.jl

@@ -1,7 +1,12 @@
-using VectorFitting
+using RationalVectorFitting
 using Documenter
 
-DocMeta.setdocmeta!(VectorFitting, :DocTestSetup, :(using VectorFitting); recursive = true)
+DocMeta.setdocmeta!(
+    RationalVectorFitting,
+    :DocTestSetup,
+    :(using RationalVectorFitting);
+    recursive = true,
+)
 
 const page_rename = Dict("developer.md" => "Developer docs") # Without the numbers
 const numbered_pages = [
@@ -10,12 +15,14 @@ const numbered_pages = [
 ]
 
 makedocs(;
-    modules = [VectorFitting],
+    modules = [RationalVectorFitting],
     authors = "Pedro H. N. Vieira <phnvieira@proton.me>",
-    repo = "https://github.com/pedrohnv/VectorFitting.jl/blob/{commit}{path}#{line}",
-    sitename = "VectorFitting.jl",
-    format = Documenter.HTML(; canonical = "https://pedrohnv.github.io/VectorFitting.jl"),
+    repo = "https://github.com/pedrohnv/RationalVectorFitting.jl/blob/{commit}{path}#{line}",
+    sitename = "RationalVectorFitting.jl",
+    format = Documenter.HTML(;
+        canonical = "https://pedrohnv.github.io/RationalVectorFitting.jl",
+    ),
     pages = ["index.md"; numbered_pages],
 )
 
-deploydocs(; repo = "github.com/pedrohnv/VectorFitting.jl")
+deploydocs(; repo = "github.com/pedrohnv/RationalVectorFitting.jl")

docs/src/90-contributing.md

@@ -8,7 +8,7 @@ Be polite and respectful, and follow the code of conduct.
 
 ## Bug reports and discussions
 
-If you think you found a bug, feel free to open an [issue](https://github.com/pedrohnv/VectorFitting.jl/issues).
+If you think you found a bug, feel free to open an [issue](https://github.com/pedrohnv/RationalVectorFitting.jl/issues).
 Focused suggestions and requests can also be opened as issues.
 Before opening a pull request, start an issue or a discussion on the topic, please.
 

docs/src/91-developer.md

@@ -17,7 +17,7 @@ If this is the first time you work with this repository, follow the instructions
 3. Add this repo as a remote:
 
    ```bash
-   git remote add upstream https://github.com/pedrohnv/VectorFitting.jl
+   git remote add upstream https://github.com/pedrohnv/RationalVectorFitting.jl
    ```
 
 This will ensure that you have two remotes in your git: `origin` and `upstream`.
@@ -149,15 +149,15 @@ To create a new release, you can follow these simple steps:
     - Add a new link in the bottom for version "x.y.z"
     - Change the "[unreleased]" link to use the latest version - end of line, `vx.y.z ... HEAD`.
 - Create a commit "Release vx.y.z", push, create a PR, wait for it to pass, merge the PR.
-- Go back to main screen and click on the latest commit (link: <https://github.com/pedrohnv/VectorFitting.jl/commit/main>)
+- Go back to main screen and click on the latest commit (link: <https://github.com/pedrohnv/RationalVectorFitting.jl/commit/main>)
 - At the bottom, write `@JuliaRegistrator register`
 
 After that, you only need to wait and verify:
 
 - Wait for the bot to comment (should take < 1m) with a link to a RP to the registry
 - Follow the link and wait for a comment on the auto-merge
 - The comment should said all is well and auto-merge should occur shortly
-- After the merge happens, TagBot will trigger and create a new GitHub tag. Check on <https://github.com/pedrohnv/VectorFitting.jl/releases>
+- After the merge happens, TagBot will trigger and create a new GitHub tag. Check on <https://github.com/pedrohnv/RationalVectorFitting.jl/releases>
 - After the release is create, a "docs" GitHub action will start for the tag.
 - After it passes, a deploy action will run.
-- After that runs, the [stable docs](https://pedrohnv.github.io/VectorFitting.jl/stable) should be updated. Check them and look for the version number.
+- After that runs, the [stable docs](https://pedrohnv.github.io/RationalVectorFitting.jl/stable) should be updated. Check them and look for the version number.

docs/src/95-reference.md

@@ -13,5 +13,5 @@ Pages = ["95-reference.md"]
 ```
 
 ```@autodocs
-Modules = [VectorFitting]
+Modules = [RationalVectorFitting]
 ```

docs/src/index.md

@@ -1,10 +1,10 @@
 ```@meta
-CurrentModule = VectorFitting
+CurrentModule = RationalVectorFitting
 ```
 
-# VectorFitting
+# RationalVectorFitting
 
-Documentation for [VectorFitting](https://github.com/pedrohnv/VectorFitting.jl).
+Documentation for [RationalVectorFitting](https://github.com/pedrohnv/RationalVectorFitting.jl).
 
 ## Contributors
 

src/RationalVectorFitting.jl

@@ -0,0 +1,11 @@
+module RationalVectorFitting
+
+"""
+    hi = hello_world()
+A simple function to return "Hello, World!"
+"""
+function hello_world()
+    return "Hello, World!"
+end
+
+end