femagtools 1.4.3__tar.gz → 1.4.5__tar.gz

{femagtools-1.4.3/src/femagtools.egg-info → femagtools-1.4.5}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: femagtools
-Version: 1.4.3
+Version: 1.4.5
 Summary: Python API for FEMAG
-Author-email: Ronald Tanner <tar@semafor.ch>, Dapu Zhang <d.zhan@gtisoft.com>, Beat Holm <hob@semafor.ch>, Günther Amsler <amg@semafor.ch>, Nicolas Mauchle <mau@semafor.ch>
+Author-email: Ronald Tanner <tar@semafor.ch>, Dapu Zhang <dzhang@gtisoft.com>, Beat Holm <hob@semafor.ch>, Günther Amsler <amg@semafor.ch>, Nicolas Mauchle <mau@semafor.ch>
 License: Copyright (c) 2016-2023, Semafor Informatik & Energie AG, Basel
         All rights reserved.
         
@@ -35,13 +35,27 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: mako
+Requires-Dist: six
+Requires-Dist: lmfit
+Requires-Dist: netCDF4
 Provides-Extra: dxfsl
+Requires-Dist: lxml; extra == "dxfsl"
+Requires-Dist: dxfgrabber; extra == "dxfsl"
+Requires-Dist: networkx; extra == "dxfsl"
 Provides-Extra: mplot
+Requires-Dist: matplotlib; extra == "mplot"
 Provides-Extra: meshio
+Requires-Dist: meshio; extra == "meshio"
 Provides-Extra: vtk
+Requires-Dist: vtk; extra == "vtk"
 Provides-Extra: zmq
+Requires-Dist: pyzmq; extra == "zmq"
 Provides-Extra: test
-License-File: LICENSE
+Requires-Dist: pytest; extra == "test"
 
 
 # Introduction to Femagtools

{femagtools-1.4.3 → femagtools-1.4.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "femagtools"
 authors = [
     {name = "Ronald Tanner", email = "tar@semafor.ch"},
-    {name = "Dapu Zhang", email = "d.zhan@gtisoft.com"},
+    {name = "Dapu Zhang", email = "dzhang@gtisoft.com"},
     {name = "Beat Holm", email = "hob@semafor.ch"},
     {name = "Günther Amsler", email = "amg@semafor.ch"},
     {name = "Nicolas Mauchle", email = "mau@semafor.ch"}

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/__init__.py

@@ -1,15 +1,8 @@
-# -*- coding: utf-8 -*-
-"""
-    femagtools
-    ~~~~~~~~~~
-
-    Python bindings for FEMAG
-
-
+"""Python API for FEMAG
 
 """
 __title__ = 'femagtools'
-__version__ = '1.4.3'
+__version__ = '1.4.5'
 __author__ = 'Ronald Tanner'
 __license__ = 'BSD'
 __copyright__ = 'Copyright 2016-2022 SEMAFOR Informatik & Energie AG'
@@ -37,12 +30,12 @@ def create_fsl(machine,
                magnetmat=[],
                condMat=[],
                templatedirs=[]):
-    """create FSL command list from model parameters
+    """create FSL command list from model and operating parameters
 
     Args:
-        machine: dict with parameters
-        operatuingConditions: dict with parameters
-        magnetmat: list fo dict with parameters
+        machine: dict with parameters (model)
+        operatingConditions: dict with parameters (simulation)
+        magnetmat: list fo dict with parameters (magnet material)
         templatedir: additional template directory
 """
     model = MachineModel(machine)

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/airgap.py

@@ -1,10 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    femagtools.airgap
-    ~~~~~~~~~~~~~~~~~
-
-    Read airgap dat file
-
+"""Read and analyze airgap dat file
 
 """
 import numpy as np
@@ -14,7 +8,7 @@ from . import utils
 logger = logging.getLogger(__name__)
 
 
-def fft(pos, b, pmod=0):
+def fft(pos: list, b: list, pmod=0) -> dict:
     """calculate fft spectrum of flux density and return samples,
     values, amplitude and phase of base harmonic
 
@@ -22,6 +16,9 @@ def fft(pos, b, pmod=0):
       pos: (list of floats) sample positions
       b: (list of floats) flux density values
       pmod: number of poles in model (ignored if 0)
+
+    Returns:
+       A dict containing the FFT values Bamp, phi0, nue, B_nue
     """
     r = utils.fft(pos, b, pmod)
     Bamp = r['a']

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/amazon.py

@@ -1,11 +1,4 @@
-"""
-    femagtools.amazon
-    ~~~~~~~~~~~~~~~~~
-
-    Running FEMAG on Amazon Cloud EC2
-
-
-
+"""running FEMAG on Amazon cloud EC2
 
     .. note: To use this engine you have to install the boto3 module from amazon
 """

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/amela.py

@@ -1,8 +1,5 @@
-'''
-    femagtools.amela
-    ~~~~~~~~~~~~~~~~
+'''Calculate Magnet Losses with AMELA
 
-    Calculate Magnet Losses with AMELA
 '''
 import sys
 import json
@@ -18,8 +15,8 @@ import subprocess
 logger = logging.getLogger(__name__)
 
 def geometry_id(bndx, bndy):
-    '''identify the magnet geometry''' 
-    # caculate magnet area 
+    '''identify the magnet geometry'''
+    # caculate magnet area
     xy = 0
     yx = 0
     for i in range(len(bndy)):
@@ -32,21 +29,21 @@ def geometry_id(bndx, bndy):
     area = np.abs(yx-xy)*0.5
 
     x0, y0 = np.mean(bndx), np.mean(bndy)
-    distances = [] 
-    for i in range(len(bndx)): 
-        for j in range(len(bndy)): 
+    distances = []
+    for i in range(len(bndx)):
+        for j in range(len(bndy)):
             dist = np.sqrt((bndx[i] - bndx[j])**2 + (bndy[i] - bndy[j])**2)
             distances.append([dist, bndx[i], bndx[j], bndy[i], bndy[j]])
-    
+
     distances.sort(reverse=True)
     xe = [distances[0][2], distances[2][1], distances[0][1], distances[2][2]]
     ye = [distances[0][4], distances[2][3], distances[0][3], distances[2][4]]
 
-    # dimension 
+    # dimension
     dim = np.zeros((3, 5))
     x1, y1 = xe[0], ye[0]
 
-    for i in range(3): 
+    for i in range(3):
         x2, y2 = xe[i+1], ye[i+1]
         dim[i, 0] = np.sqrt((x2-x1)**2 + (y2-y1)**2)
         dim[i, 1:3] = [x1, x2]
@@ -55,79 +52,75 @@ def geometry_id(bndx, bndy):
     dim = dim[np.lexsort((dim[:, 2], dim[:, 1], dim[:, 0]))]
     dx12, dy12 = dim[1, 1] - dim[1, 2],  dim[1, 3] - dim[1, 4]
     dx14, dy14 = dim[0, 1] - dim[0, 2],  dim[0, 3] - dim[0, 4]
-    
+
     alp1 = np.arctan2(dy12, dx12)
     alp2 = np.arctan2(dy14, dx14)
 
     if alp1 < 0: alp1 += 2*np.pi
     if alp2 < 0: alp2 += 2*np.pi
-    if alp2 < alp1: 
+    if alp2 < alp1:
         alp2 += np.pi
         alpha = (alp1 + (alp2 - np.pi/2))/2
-    else: 
+    else:
         alpha = (alp1 + (alp2 - np.pi/2))/2 + np.pi
-    
+
     wm = dim[1, 0]
-    hm = area/wm 
+    hm = area/wm
 
-    return dict(wm=wm, 
-                hm=hm, 
-                x0=x0, 
+    return dict(wm=wm,
+                hm=hm,
+                x0=x0,
                 y0=y0,
-                area=area, 
+                area=area,
                 alpha=alpha)
 
 def tf(b1, b2, alpha):
     '''Tranformation Matrix'''
-    T = np.array([[cos(alpha), sin(alpha)], 
-                [-sin(alpha), cos(alpha)]]) 
-    if b1.ndim > 1: 
+    T = np.array([[cos(alpha), sin(alpha)],
+                [-sin(alpha), cos(alpha)]])
+    if b1.ndim > 1:
         r = T.dot(((b1.ravel()), (b2.ravel())))
-        return [r[0, :].reshape(*b1.shape), 
+        return [r[0, :].reshape(*b1.shape),
                 r[1, :].reshape(*b1.shape)]
-    else: 
+    else:
         return T.dot(((b1), (b2)))
 
-def transform_coord(geometry, xcp, ycp): 
+def transform_coord(geometry, xcp, ycp):
     '''transform from global coord to local coord'''
-    # transformation 
-    elcp = tf(b1=np.array(xcp)-geometry['x0'], 
-              b2=np.array(ycp)-geometry['y0'], 
+    # transformation
+    elcp = tf(b1=np.array(xcp)-geometry['x0'],
+              b2=np.array(ycp)-geometry['y0'],
               alpha=geometry['alpha'])
-    return dict(excpl=elcp[0, :]+geometry['wm']/2, 
-                eycpl=elcp[1, :]+geometry['hm']/2, 
-                excp=np.array(xcp), 
+    return dict(excpl=elcp[0, :]+geometry['wm']/2,
+                eycpl=elcp[1, :]+geometry['hm']/2,
+                excp=np.array(xcp),
                 eycp=np.array(ycp))
 
-def transform_flux_denstiy(geometry, bx, by): 
+def transform_flux_denstiy(geometry, bx, by):
     '''transform the magnet flux density to local coordinate system'''
-    # transformation 
-    bxy = tf(b1=bx, 
-             b2=by, 
+    # transformation
+    bxy = tf(b1=bx,
+             b2=by,
              alpha=geometry['alpha'])
 
     # remove DC component
     bxf = np.mean(bxy[0].T - np.mean(bxy[0],axis=1).T,axis=1)
-    byf = np.mean(bxy[1].T - np.mean(bxy[1],axis=1).T,axis=1)               
-     
+    byf = np.mean(bxy[1].T - np.mean(bxy[1],axis=1).T,axis=1)
+
     return dict(bxl=bxy[0],
                 byl=bxy[1],
-                bxf=bxf, 
-                byf=byf 
+                bxf=bxf,
+                byf=byf
                 )
 
 class Amela():
     '''Run Amela Calculation
-    Parameters
-    ----------
-    workdir : str
-        working directory of femag calculation
-        (The directory that the nc file)
-    amela_dir: str (optional)
-        amela directory 
-    magnet_data : dict
-        calculation control
-        -- name must be provided
+
+    Args:
+      workdir : working directory of femag calculation
+        (The directory that includes the nc file)
+      amela_dir: str (optional) amela directory
+      magnet_data : calculation control name must be provided
         dict(name='test',
         -- the following parameters are optional
              mur=1.05,
@@ -135,18 +128,18 @@ class Amela():
              hm=3,
              wm=20,
              lm=30,
-             speed=1000, 
-             nsegwid=0, 
+             speed=1000,
+             nsegwid=0,
              nseglen=0)
     '''
 
-    def __init__(self, workdir, magnet_data, amela_dir=None):
+    def __init__(self, workdir: str, magnet_data: dict, amela_dir=None):
 
         self.magn = magnet_data
         self.workdir = pathlib.Path(workdir)
-        if amela_dir is not None: 
+        if amela_dir is not None:
             self.amela_dir = pathlib.Path(amela_dir)
-        else: 
+        else:
             self.amela_dir = self.workdir
 
         self.jsonfile = []
@@ -154,7 +147,7 @@ class Amela():
             self.cmd = [str(self.amela_dir / 'AMELA.BAT')]
         else:
             self.cmd = [str(self.amela_dir / 'AMELA')]
-        # default batch 
+        # default batch
         self.cmd.append('--b')
         # append calc options
         if 'speed' in self.magn:
@@ -164,14 +157,15 @@ class Amela():
         if 'nseglen' in self.magn:
             self.cmd.append(f"--nseglen {self.magn['nseglen']}")
 
-    def get_magnet_data(self, ibeta=None):
+    def get_magnet_data(self, ibeta=None) -> list:
         '''Extract magnet data from nc file
-        Parameters
-        ----------
-            None
-        Returns
-        ----------
-        pm_data: list of magnet data
+
+        Args:
+            ibeta: load case
+
+        Returns:
+          pm_data: list of magnet data
+
         '''
         nc_name = self.workdir / self.magn['name']
         r = femagtools.nc.read(nc_name)
@@ -194,7 +188,7 @@ class Amela():
         wm = []
         hm = []
         alpha = []
-        x0 = [] 
+        x0 = []
         y0 = []
         geometry = []
         elcp = []
@@ -255,7 +249,7 @@ class Amela():
         poles = 0
         try:
             poles = r.num_poles
-        except:
+        except AttributeError:
             pass
 
         # read mesh and flux density
@@ -279,7 +273,6 @@ class Amela():
             elcp.append(transform_coord(geometry[i], xcp[i], ycp[i]))
             bl.append(transform_flux_denstiy(geometry[i], bx[i][0], by[i][0]))
 
-
         if poles == 0:
             freq = self.magn.get('f', r.speed)
             time_vec = np.linspace(0, 1/freq, len(r.pos_el_fe_induction))
@@ -314,7 +307,7 @@ class Amela():
                                 bndy=[float(c) for c in bndy[i]],
                                 bl=bl[i],
                                 elcp=elcp[i],
-                                area=spel_area[i], 
+                                area=spel_area[i],
                                 spel_key=spel_key[i]))
             pm_data[i].update(pos)
 
@@ -340,7 +333,7 @@ class Amela():
         else:
             return [pm_data[0]]
 
-    def get_magnet_data_all(self, num_op): 
+    def get_magnet_data_all(self, num_op):
         '''get all magnet data for all loadcases'''
         pm_data = []
         for i in num_op:
@@ -348,15 +341,12 @@ class Amela():
             pm_data.append(pmd)
         return pm_data
 
-    def export_json(self, pm_data):
+    def export_json(self, pm_data: list):
         '''Export magnet data to json files
-        Parameters
-        ----------
-        pm_data: list of magnet data
-        Returns
-        ----------
-        None
-        ----------
+
+        Args:
+          pm_data: list of magnet data
+
         '''
         pm_dir = self.amela_dir / self.magn['name']
         pm_dir.mkdir(exist_ok=True)
@@ -370,15 +360,14 @@ class Amela():
                 json.dump(i, f)
             logger.info('Exporting %s ...', i['name'])
 
-    def read_loss(self, pm_data):
+    def read_loss(self, pm_data: dict) -> dict:
         '''Read magnet losses
-        Parameters
-        ----------
-            pm_data : dict
-        Returns
-        ----------
-            losses : dict
-        ----------
+
+        Args:
+          pm_data : dict
+
+        Returns:
+          losses
         '''
         losses = {}
         for i in range(len(pm_data)):
@@ -387,27 +376,26 @@ class Amela():
             result_name = self.amela_dir / dirname
             with result_name.open() as f:
                 data = np.loadtxt(f)
-                total_loss = np.mean(data[0:-1, -1]) 
+                total_loss = np.mean(data[0:-1, -1])
                 losses[pm_data[i]['name']] = {"loss_data":data, "total_loss": total_loss}
                 logger.info("Magnet losses in superelement %s is %.3f W",
                             pm_data[i]['name'].split('se')[-1], total_loss)
         return losses
 
-    def __call__(self, ialh=False):
+    def __call__(self, ialh=False) -> dict:
         '''Run amela calculation
-        Parameters
-        ----------
-            None
-        Returns
-        ----------
-            losses : dict
-        ----------
+
+        Args:
+          ialh: use method IALH if True else 3DI
+
+        Returns:
+            losses
         '''
         # get magnet data
         r = self.get_magnet_data()
         # export to json
         self.export_json(r)
-        # run amela 
+        # run amela
         calc_method = 'IALH' if ialh else '3DI'
         cmd = self.cmd + ['--calc', calc_method, self.magn['name'] + '/']
         log_file = self.amela_dir / 'amela.out'

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/asm.py

@@ -1,9 +1,5 @@
 # -*- coding: utf-8 -*-
-"""
-    femagtools.asm
-    ~~~~~~~~~~~~~~
-
-    Reading ASM files
+""" Read ASM files
 
 Slots Qr:
 

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/bch.py

@@ -1,11 +1,5 @@
 # -*- coding: utf-8 -*-
-"""
-    femagtools.bch
-    ~~~~~~~~~~~~~~
-
-    Reading BCH/BATCH files
-
-
+"""read BCH/BATCH files
 
 """
 import sys
@@ -442,7 +436,7 @@ class Reader:
 
     def __read_current_angles(self, content):
         self.current_angles = []
-        r = [] 
+        r = []
         extracting = False
         for l in content:
             rec = self.__findNums(l)
@@ -450,10 +444,10 @@ class Reader:
                 self.current_angles.append(floatnan(rec[-1]))
             if l.strip().startswith('Optimization of angle'):
                 extracting = True
-            elif l.strip().startswith('Optimimal angle I'): 
+            elif l.strip().startswith('Optimimal angle I'):
                 break
-            else: 
-                if extracting: 
+            else:
+                if extracting:
                     if l.strip() == '' or \
                         l.strip().startswith('Angle [Degr'):
                         pass
@@ -461,7 +455,7 @@ class Reader:
                         tmp = l.split('\t')
                         r.append([floatnan(k) for k in tmp])
         if len(r) > 1:
-            self.torque_opt.append({'beta': [i[0] for i in r], 
+            self.torque_opt.append({'beta': [i[0] for i in r],
                                     'torque': [i[1] for i in r]})
         return
 
@@ -1630,7 +1624,7 @@ class Reader:
 
                 except:
                     pass
-    
+
     def get(self, name, r=None):
         """return value of key name
         name can be a list such as ['torque[1]', 'ripple']

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/bchxml.py

@@ -1,10 +1,7 @@
 #!/usr/bin/env python
-#
-# convert bch to xml
-#
-# Author: Ronald Tanner
-# 2016-10-20
-#
+"""convert bch to xml
+
+"""
 import sys
 import re
 import io
@@ -17,9 +14,15 @@ def usage():
     sys.exit(1)
 
 
-def list_to_xml(tag, l):
-    '''
-    Turn a list into XML
+def list_to_xml(tag: str, l: list) -> el.Element:
+    '''convert a list into XML
+
+    Args:
+      tag: name of element
+      l: list of values
+
+    Returns:
+      xml element with tag and values
     '''
 
     if not isinstance(tag, str):
@@ -43,9 +46,15 @@ def list_to_xml(tag, l):
     return elem
 
 
-def dict_to_xml(tag, d):
-    '''
-    Turn a simple dict of key/value pairs into XML
+def dict_to_xml(tag: str, d: dict) -> el.Element:
+    '''convert a simple dict of key/value pairs into XML
+
+    Args:
+       tag: name of element
+       d: dict of values
+
+    Returns:
+      xml element of d
     '''
 
     if not isinstance(tag, str):
@@ -70,7 +79,7 @@ def dict_to_xml(tag, d):
 
 
 def main():
-    import argparse 
+    import argparse
     from .__init__ import __version__
     from femagtools.bch import Reader
 
@@ -88,7 +97,7 @@ def main():
     args = argparser.parse_args()
     if not args.filename:
         sys.exit(0)
-    
+
     bchresults = Reader()
     with io.open(args.filename, encoding='latin1', errors='ignore') as f:
         bchresults.read(f.readlines())

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/dakota.py

@@ -27,36 +27,31 @@ logger = logging.getLogger(__name__)
 use_asyncio = True
 
 
-@asyncio.coroutine
-def read_stream_and_display(stream, display):
+async def read_stream_and_display(stream, display):
     """Read from stream line by line until EOF, display, and capture the lines.
 
     """
     output = []
-    while True:
-        line = yield from stream.readline()
-        if not line:
-            break
+    async for line in stream.readline():
         output.append(line)
         display(line)  # assume it doesn't block
     return b''.join(output)
 
 
-@asyncio.coroutine
-def read_and_display(*cmd, cwd):
+async def read_and_display(*cmd, cwd):
     """Capture cmd's stdout, stderr while displaying them as they arrive
     (line by line).
 
     """
     # start process
-    process = yield from asyncio.create_subprocess_exec(*cmd, cwd=cwd,
-                                                        stdout=PIPE, stderr=PIPE)
+    process = await asyncio.create_subprocess_exec(*cmd, cwd=cwd,
+                                                   stdout=PIPE, stderr=PIPE)
 
     def nodisplay(l):
         return
     # read child's stdout/stderr concurrently (capture and display)
     try:
-        stdout, stderr = yield from asyncio.gather(
+        stdout, stderr = asyncio.gather(
             read_stream_and_display(process.stdout, nodisplay),
             read_stream_and_display(process.stderr, sys.stderr.buffer.write))
     except Exception:
@@ -64,7 +59,7 @@ def read_and_display(*cmd, cwd):
         raise
     finally:
         # wait for the process to exit
-        rc = yield from process.wait()
+        rc = process.wait()
     return rc, stdout, stderr
 
 

{femagtools-1.4.3 → femagtools-1.4.5}/src/femagtools/dakota_femag.py

@@ -6,7 +6,6 @@ import sys
 import pathlib
 import logging
 import femagtools.grid
-import model
 import importlib
 import os
 
@@ -73,6 +72,7 @@ def read_paramsin(p):
 
 
 if __name__ == '__main__':
+    import model
     logging.basicConfig(level=logging.INFO,
                         format='%(asctime)s %(message)s')
 

femagtools-1.4.5/src/femagtools/dxfsl/__init__.py

@@ -0,0 +1,8 @@
+"""
+    femagtools.dxfsl
+    ~~~~~~~~~~~~~~~~
+
+    convert dxf to fsl
+
+
+"""