{"action":"created","issue":{"url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/217","repository_url":"https://api.github.com/repos/scikit-rf/scikit-rf","labels_url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/217/labels{/name}","comments_url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/217/comments","events_url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/217/events","html_url":"https://github.com/scikit-rf/scikit-rf/issues/217","id":334569518,"node_id":"MDU6SXNzdWUzMzQ1Njk1MTg=","number":217,"title":"one-port cal documentation error","user":{"login":"ScottHinton","id":35308431,"node_id":"MDQ6VXNlcjM1MzA4NDMx","avatar_url":"https://avatars1.githubusercontent.com/u/35308431?v=4","gravatar_id":"","url":"https://api.github.com/users/ScottHinton","html_url":"https://github.com/ScottHinton","followers_url":"https://api.github.com/users/ScottHinton/followers","following_url":"https://api.github.com/users/ScottHinton/following{/other_user}","gists_url":"https://api.github.com/users/ScottHinton/gists{/gist_id}","starred_url":"https://api.github.com/users/ScottHinton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ScottHinton/subscriptions","organizations_url":"https://api.github.com/users/ScottHinton/orgs","repos_url":"https://api.github.com/users/ScottHinton/repos","events_url":"https://api.github.com/users/ScottHinton/events{/privacy}","received_events_url":"https://api.github.com/users/ScottHinton/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-06-21T16:32:17Z","updated_at":"2018-06-21T16:34:27Z","closed_at":null,"author_association":"NONE","body":"Three issues:\r\n1. In the one-port cal code you have a reference to the page http://na.support.keysight.com/vnahelp/tip20.html which I found very helpful.  It derives the equations behind the one-port cal, but if I'm understanding it correctly it looks like you have an error in your OnePort class docstring.  You give the fancy LaTeX-formatted equations that are to be solved, but it appears that the m's and the i's are swapped.  For example, you wrote \"e_{11}\\mathbf{i_1m_1}-\\Delta e\\,\\mathbf{m_1}+e_{00}=\\mathbf{i_1}\" -> e11*i1*m1 - delta_e*m1 + e00 = i1, however it should be e11*i1*m1 - delta_e*i1 + e00 = m1.  This is properly reflected in the math implemented in the class' code.\r\n\r\n2. I was confused for a while with your code because of your notation.  You appear to follow the same a, b, c notation as found in the reference I mentioned above, except for one slight difference: they define \"c = -e11\" but you use c = e11 (no negative), and the resulting equations that you use adapt accordingly.  I think it would be helpful to add a comment in your code explaining that minor difference.\r\n\r\n3. One final, minor point: in OnePort.run() you have a comment \"# ASSERT: mList and aList are now kx1x1 matrices, where k in frequency\".  Actually k is equal to the number of frequency points in one's measurement times 4 (the number of S-parameters in the 2-port measurement) since you performed a \"measured.s.reshape\" operation.  Like I said, it's minor, but when people are not experts in this field and are still trying to navigate (in my case it's less like navigating and more like stumbling) their way through it, minor errors can become confusing obstacles.\r\n\r\nI realize that I could propose these changes by cloning the project, making the edits, then making a pull request or something like that, but since I'm not a git expert I'd rather not spend the time figuring out how to do it since that would take an order of magnitude more time than simply making the corrections.  Please forgive my laziness."},"comment":{"url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/comments/399166317","html_url":"https://github.com/scikit-rf/scikit-rf/issues/217#issuecomment-399166317","issue_url":"https://api.github.com/repos/scikit-rf/scikit-rf/issues/217","id":399166317,"node_id":"MDEyOklzc3VlQ29tbWVudDM5OTE2NjMxNw==","user":{"login":"ScottHinton","id":35308431,"node_id":"MDQ6VXNlcjM1MzA4NDMx","avatar_url":"https://avatars1.githubusercontent.com/u/35308431?v=4","gravatar_id":"","url":"https://api.github.com/users/ScottHinton","html_url":"https://github.com/ScottHinton","followers_url":"https://api.github.com/users/ScottHinton/followers","following_url":"https://api.github.com/users/ScottHinton/following{/other_user}","gists_url":"https://api.github.com/users/ScottHinton/gists{/gist_id}","starred_url":"https://api.github.com/users/ScottHinton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ScottHinton/subscriptions","organizations_url":"https://api.github.com/users/ScottHinton/orgs","repos_url":"https://api.github.com/users/ScottHinton/repos","events_url":"https://api.github.com/users/ScottHinton/events{/privacy}","received_events_url":"https://api.github.com/users/ScottHinton/received_events","type":"User","site_admin":false},"created_at":"2018-06-21T16:34:27Z","updated_at":"2018-06-21T16:34:27Z","author_association":"NONE","body":"It looks like the interpreter changed some of my shorthand equation with asterisks into italics, *like this*.  Obviously I'm a markdown newbie."}}
{"actor":{"display_login":"ScottHinton"}}