pyRFtk 2.0.7__tar.gz → 2.0.9__tar.gz

{pyrftk-2.0.7 → pyrftk-2.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyRFtk
-Version: 2.0.7
+Version: 2.0.9
 Summary: Design tool for RF antennae networks
 Project-URL: Homepage, https://lpp-erm-kms.github.io/pyrftk/
 Author-email: Frederic Durodie <frederic.durodie@rma.ac.be>, Arthur Adriaens <arthur.adriaens@mil.be>
@@ -23,7 +23,19 @@ you can:
 - Detect Arcs
 - Deembed systems
 - ...
+  
+## Installation
+pyRFtk is available as a pip package:
+
+```sh
+pip install pyRFtk
+```
+
+Or using your favorite distribution platform
 
 ## Authors
 The code was developed by RF-engineer Frederic Durodie and later
 on refactored, packaged and documented by Arthur Adriaens
+
+## Example usage
+This code was extensively used for the paper [An automatic matching system for the ICRF antenna at TOMAS: Development and experimental proof](https://doi.org/10.1016/j.fusengdes.2025.114840), the code for which may be found in the examples folder.

{pyrftk-2.0.7 → pyrftk-2.0.9}/README.md

@@ -11,7 +11,19 @@ you can:
 - Detect Arcs
 - Deembed systems
 - ...
+  
+## Installation
+pyRFtk is available as a pip package:
+
+```sh
+pip install pyRFtk
+```
+
+Or using your favorite distribution platform
 
 ## Authors
 The code was developed by RF-engineer Frederic Durodie and later
 on refactored, packaged and documented by Arthur Adriaens
+
+## Example usage
+This code was extensively used for the paper [An automatic matching system for the ICRF antenna at TOMAS: Development and experimental proof](https://doi.org/10.1016/j.fusengdes.2025.114840), the code for which may be found in the examples folder.

{pyrftk-2.0.7 → pyrftk-2.0.9}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling","numpy","matplotlib","logging"]
 build-backend = "hatchling.build"
 [project]
 name = "pyRFtk"
-version = "2.0.7"
+version = "2.0.9"
 authors = [
   { name="Frederic Durodie", email="frederic.durodie@rma.ac.be" },
   { name="Arthur Adriaens", email="arthur.adriaens@mil.be" },
@@ -17,3 +17,5 @@ classifiers = [
 ]
 [project.urls]
 "Homepage" = "https://lpp-erm-kms.github.io/pyrftk/"
+[tool.hatch.build]
+exclude = ["docs", "tests", "examples"]

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/ReadTSF.py

@@ -1,4 +1,4 @@
-__updated__ = "2025-01-21 15:58:36"
+__updated__ = "2026-05-20 14:58:47"
 
 import numpy as np
 import re
@@ -349,14 +349,15 @@ def ReadTSF(src, **kwargs):
     
     ## do some checking
     nZcs, nZbase = 0, 0
-    if len(Zcs) and (nZcs := Zcs.shape[1]):
+    if len(Zcs) and (nZcs := np.array(Zcs).shape[1]):
         # Zcs (and probably gammas) were present in the file
         if Zbase is not None:
             # there was also a R ... in the format
             if (nZbase := len(Zbase) if hasattr(Zbase, '__iter__') else 1) != nZcs :
-                warn(f'\nInconsistent length of the Zcs ({nZcs}) comments and the '
-                     f'format supplied reference impedance R ({nZbase})',
-                     stacklevel=4)
+                if False:
+                    warn(f'\nInconsistent length of the Zcs ({nZcs}) comments and the '
+                         f'format supplied reference impedance R ({nZbase})',
+                         stacklevel=4)
             else:
                 # numbers match ... but do the values
                 if nZbase == 1:
@@ -376,7 +377,9 @@ def ReadTSF(src, **kwargs):
             if nZbase == 1 and nZcs != 1:
                 err = []
     
-            
+    else: # this should be the case when no Zcs or gammas are present
+        nZbase = len(Zlist)
+                
         
     # if the data type is Z or Y we need to convert to S
                 
@@ -397,6 +400,7 @@ def ReadTSF(src, **kwargs):
                 
         elif Zbase is not None and (nZbase == 1 or nZbase == Ss.shape[1]):
             Ss = ConvertGeneral(TZbase if TZbase else 50., Ss, Zbase, 'P', 'V')
+            # print(f'have converted the data from {Zbase} in the touchstone  to {TZbase}')
     
         elif Zbase is None: # No Zcs and Zbase is None:
             Ss = ConvertGeneral(TZbase if TZbase else 50., Ss, Zcs, 'P', 'V')
@@ -404,6 +408,7 @@ def ReadTSF(src, **kwargs):
         else:
             logit['ERROR'] and tLogger.error(f'len(Zcs)[{len(Zcs)}] != N[{N}]')
             logit['ERROR'] and tLogger.error(f'Zcs={Zcs}')
+            raise ValueError('in ReadTSF: please specify Zbase')
         
                 
     # set the portnames
@@ -440,6 +445,7 @@ def ReadTSF(src, **kwargs):
         debug and tLogger.debug(ident(f'set ports to {ports}'))
     
     debug and tLogger.debug(ident(f'< [CommonLib.ReadTSF]',-1))
+    
     return {        
         "ports"     : ports,
         "fs"        : fs,

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/WriteTSF.py

@@ -95,6 +95,7 @@ def WriteTSF(object, path2tsf=None,
             num_format = ('8.4f', '10.7f', '10.7f')
     
     tnumfmt = f'%{num_format[1]} %{num_format[2]} '
+    leadspaces = ' '*(1 + int(num_format[0].split('.')[0]))
     
     for k,fk in enumerate(fs):
         s += (f'%{num_format[0]}' % (fk / fscale)) + ' '
@@ -106,7 +107,7 @@ def WriteTSF(object, path2tsf=None,
                     s += tnumfmt % (np.real(dij),np.imag(dij))
                     
                 elif fmt == 'DB':
-                    s += tnumfmt% (20.*np.log10(np.abs(dij)),
+                    s += tnumfmt % (20.*np.log10(np.abs(dij)),
                                                np.angle(dij,1))
                     
                 else: # can only be MA
@@ -115,12 +116,12 @@ def WriteTSF(object, path2tsf=None,
                 if (kc % 4 == 3) and (kc is not nports-1):
                     if kc == 3:
                         s += ' !    row %d' % (kr+1)
-                    s += '\n'+' '*10
+                    s += '\n' + leadspaces
                     
             if nports > 2:
                 s += '\n'
                 if kr != nports-1:
-                    s += ' '*9
+                    s += leadspaces
 
         s += '\n'      
                 

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/__init__.py

@@ -1,6 +1,6 @@
-__updated__ = "2025-01-24 07:58:36"
+__updated__ = "2026-04-24 09:20:26"
 
-# print('\n*** using local copy of pyRFtk ***\n')
+print('\n*** using local copy of pyRFtk ***\n')
 
 from .config import tLogger, setLogLevel, logit, ident, _newID, logident
 from .rfBase import rfBase

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/rfCircuit.py

@@ -1,4 +1,6 @@
-__updated__ = "2023-11-09 10:00:05"
+__updated__ = "2026-05-19 11:11:41"
+
+#FIXME: addblock of a np.array fails because of xpos issues (also __str__ fails)
 
 import numpy as np
 import matplotlib.pyplot as plt
@@ -292,6 +294,30 @@ class rfCircuit(rfBase):
         
         return obj
     
+    #==============================================================================================
+    #
+    # o b j e c t
+    #
+    def object(self,path):
+        """object
+            
+            returns the object pointed to by path
+            
+            eg. rfCircuit_object = self.object('block1.block2. ... .blockN')
+            
+            is equivalent to
+            
+            rfCircuit_object = \
+               self.blocks['block1']['object'].blocks['block2']['object']. ... .blocks['blockN']['object']
+               
+            Note this is similar to findObj 
+        """
+        obj = self
+        for blk in path.split('.'):
+            obj = obj.blocks[blk]['object']
+        
+        return obj
+    
     #===========================================================================
     #
     # _ s u b s t p o r t s
@@ -692,8 +718,12 @@ class rfCircuit(rfBase):
         
         # update the self.xpos
         # self.xpos = []
-        for p, x in zip(oports, RFobj.xpos):
-            self.xpos.append(relpos + x)
+        if hasattr(RFobj,'xpos'):
+            for p, x in zip(oports, RFobj.xpos):
+                self.xpos.append(relpos + x)
+        else:
+            for p in oports:
+                self.xpos.append(relpos)
                 
         _debug_ and tLogger.debug(ident(
             f'< [circuit.addblock] (inserted a new block)', -1

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/rfGTL.py

@@ -59,6 +59,8 @@ class rfGTL(rfCircuit):
             
         with open(path2model,'r') as f:
             self.model = ast.literal_eval(f.read())
+            
+        pprint(self.model)
         
         try:
             self.GTL = self.model[self.objkey]['GTL']

{pyrftk-2.0.7 → pyrftk-2.0.9}/src/pyRFtk/rfObject.py

@@ -1,4 +1,6 @@
-__updated__ = "2023-11-08 11:19:50"
+__updated__ = "2026-05-20 14:05:43"
+
+#TODO: add the possibility to fill doing  rfObject(fs=[ ...], Ss=[ ... ])
 
 if __name__ == '__main__':
     import sys
@@ -60,9 +62,9 @@ class rfObject():
     and 
     
     excitation = {port1:a1, ... }
-    Vamx, rfObject.maxV(fHz, excitation)
+    Vmax, rfObject.maxV(fHz, excitation)
     
-   
+    [note code partially debugged using co-pilot (GPT-5 mini)]
     """
     #===========================================================================
     #
@@ -85,6 +87,8 @@ class rfObject():
             fixme: no parameters to set the Zcs and Gms port properties
         """
         
+        self.got_args = False
+        
         if not hasattr(self,'args'):
             self.args = args
         
@@ -93,12 +97,76 @@ class rfObject():
         
         self.Id = kwargs.pop('Id',f'{type(self).__name__}_{_newID()}')
         
+        # if only an arg is given -> convert it (type cast) to an rfObject
+        # this eg to convert a list/numpy array to an rfOject
+        #
+        # obj = rfObject(numpy.array([[0,1],[1,0]])
+        # obj.getS(fs) returns [[0,1],[1,0]] for all frequenies fs
+        #
+        # what could be valid kwargs ?
+        #
+        # ports, xpos, Zbase 
+        
+        # print(f'rfObject: Nargs = {len(args)}')
+        
+        if Nargs := len(args):
+            if Nargs == 1:
+                # check type of arg
+                if not isinstance(args[0], (np.ndarray, np.matrix, list)):
+                    raise TypeError(
+                        f'rfObject: args[0] must be of type list, numpy.array or '
+                        f'numpy.matrix; got {type(args[0])}')
+                
+                arg0 = np.array(args[0], dtype=complex)
+                
+                if len(arg0.shape) != 2:
+                    raise TypeError(
+                        f'rfObject: arg[0] must must represent a square 2-dim '
+                        f'array; got {arg0.shape}')
+                 
+                if arg0.shape[0] != arg0.shape[1]:   
+                    raise TypeError(
+                        f'rfObject: arg[0] must must represent a square 2-dim '
+                        f'array; got {arg0.shape[0]} x {arg0.shape[1]}')
+                    
+                self.N = arg0.shape[0]
+                self.ports = [f'm{k:03d}' for k in range(1,self.N+1)]
+                self.Ss = np.array([arg0, arg0])
+                self.fs = np.array([0, 1e18])
+
+                self.got_args = True
+                
+            elif Nargs == 2:
+                raise NotImplementedError()
+            
+            else:
+                raise TypeError(f"rfObject: at most 2 args expected; got {Nargs}")
+        
         #TODO: validate allowed port names
-        self.ports = kwargs.get('ports',[])
-        self.alias = {}
-        if isinstance(self.ports, str):
-            self.ports = self.ports.split()
-        self.N = len(self.ports)
+
+        self.alias = {} #FIXME: what was the idea again ... does not appear to be used
+
+        _ports = kwargs.get('ports', [])
+        if isinstance(_ports, str):
+            _ports = _ports.split()
+        _N = len(_ports)
+        
+        # If the object was created from an argument (e.g. an S-matrix),
+        # self.N and self.ports may already be set. Only override ports
+        # from kwargs when the caller actually provided a non-empty ports list.
+        if hasattr(self, 'N'):
+            if _N:
+                if _N != self.N:
+                    raise ValueError(
+                        f'rfObject: the supplied args suggests a {self.N} port '
+                        f'object but the supplied port kwarg suggests a {_N} port one')
+                # override only when ports were explicitly provided
+                self.ports = _ports
+        else:
+            # no N previously set -> use provided ports count (may be zero)
+            self.N = _N
+            # assign provided ports (may be empty list)
+            self.ports = _ports
         
         self.Zbase = kwargs.get('Zbase', rcparams['Zbase'])
         self.funit = kwargs.get('funit', rcparams['funit'])
@@ -107,13 +175,17 @@ class rfObject():
         
         self.interp = kwargs.get('interp',rcparams['interp'])
         self.interpkws = kwargs.get('interpkws',rcparams['interpkws'])
-        
+            
         self.xpos = kwargs.get('xpos', [0.]*self.N)
-        
+                
         # initialize arrays and stuff
-        self.fs = np.array([],dtype=float).reshape((0,))
+        if not hasattr(self,'fs'):
+            self.fs = np.array([],dtype=float).reshape((0,))
         self.sorted = True
-        self.Ss = np.array([], dtype=complex).reshape((0, self.N, self.N))
+        
+        if not hasattr(self, 'Ss'):
+            self.Ss = np.array([], dtype=complex).reshape((0, self.N, self.N))
+            
         self.Zcs = np.array([], dtype=complex).reshape(0, self.N)
         self.Gms = np.array([], dtype=complex).reshape(0, self.N)
         self.process_kwargs()
@@ -121,13 +193,22 @@ class rfObject():
         
         self.touchstone = kwargs.get('touchstone', None)
         if self.touchstone:
+            if self.got_args:
+                raise ValueError(
+                    f'rfObject: touchstone is not compatible with the use of args')
+                
             Tkwargs = {'Zbase': self.Zbase, 'funit':'HZ'}
+            # FIXME: if Zbase is not supplied it defaults to 50 Ohm but that is
+            #        not taking into account the information supplied in the 
+            #        touchstone !
+            
             for (kw, value) in kwargs.items():
                 if kw in Tkwargs:
                     Tkwargs[kw] = value
             
             self.read_tsf(self.touchstone, **Tkwargs)
-        
+
+
         self.interpOK = False
         
         self.f, self.S = None, None
@@ -214,7 +295,10 @@ class rfObject():
         for kw, val in self.kwargs.items():
             s += ',\n'
             s += '  %s = %r' % (kw,val)
+        if 'Zbase' not in self.kwargs:
+            s += f'\n  Zbase = {self.Zbase} [default]'
         s += '\n)'
+       
         return s
     
     #===========================================================================
@@ -673,3 +757,4 @@ class rfObject():
                 f'pyRFtk2.rfObject.deembed: port(s) {",".join([p for p in ports])}'
                 ' not found.')
 
+

pyrftk-2.0.7/docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pyrftk-2.0.7/docs/build/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cb251cce34174a1cdced4cac6de7a8a9
-tags: 645f666f9bcd5a90fca523b33c5a78b7

pyrftk-2.0.7/docs/build/Arcs.html

@@ -1,103 +0,0 @@
-<!DOCTYPE html>
-<html class="writer-html5" lang="en" >
-<head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
-
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Arc Detection &mdash; pyRFtk 2.0.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
-  <!--[if lt IE 9]>
-    <script src="_static/js/html5shiv.min.js"></script>
-  <![endif]-->
-  
-        <script src="_static/jquery.js?v=5d32c60e"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=51b770b3"></script>
-        <script src="_static/doctools.js?v=888ff710"></script>
-        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-    <script src="_static/js/theme.js"></script>
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
-</head>
-
-<body class="wy-body-for-nav"> 
-  <div class="wy-grid-for-nav">
-    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
-      <div class="wy-side-scroll">
-        <div class="wy-side-nav-search" >
-
-          
-          
-          <a href="index.html" class="icon icon-home">
-            pyRFtk
-          </a>
-<div role="search">
-  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
-    <input type="hidden" name="check_keywords" value="yes" />
-    <input type="hidden" name="area" value="default" />
-  </form>
-</div>
-        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <ul>
-<li class="toctree-l1"><a class="reference internal" href="Tutorials.html">Tutorials</a></li>
-</ul>
-
-        </div>
-      </div>
-    </nav>
-
-    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
-          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">pyRFtk</a>
-      </nav>
-
-      <div class="wy-nav-content">
-        <div class="rst-content">
-          <div role="navigation" aria-label="Page navigation">
-  <ul class="wy-breadcrumbs">
-      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">Arc Detection</li>
-      <li class="wy-breadcrumbs-aside">
-            <a href="_sources/Arcs.rst.txt" rel="nofollow"> View page source</a>
-      </li>
-  </ul>
-  <hr/>
-</div>
-          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-           <div itemprop="articleBody">
-             
-  <section id="arc-detection">
-<h1>Arc Detection<a class="headerlink" href="#arc-detection" title="Link to this heading"></a></h1>
-</section>
-
-
-           </div>
-          </div>
-          <footer>
-
-  <hr/>
-
-  <div role="contentinfo">
-    <p>&#169; Copyright 2023, Frederic Durodie and Arthur Adriaens.</p>
-  </div>
-
-  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
-    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
-    provided by <a href="https://readthedocs.org">Read the Docs</a>.
-   
-
-</footer>
-        </div>
-      </div>
-    </section>
-  </div>
-  <script>
-      jQuery(function () {
-          SphinxRtdTheme.Navigation.enable(true);
-      });
-  </script> 
-
-</body>
-</html>