test bugfix LineV, small dokufix

Author: OrtnerMichael

CHANGELOG.md

@@ -9,8 +9,9 @@ All notable changes to magpylib are documented here.
 ## [2.2.0b] - 2019-12-27
 
 ### Changed
-- Improved performance of getB for diametral magnetized Cylinders by 20%
-- IMPORTANT: position arguments of `getBv` functions have been flipped! First comes the source position POSm THEN the observer position POSo!
+- Improved performance of getB for diametral magnetized Cylinders by 20%.
+- GetB of Line current now uses vectorized code which leads to massive performance enhancement.
+- **IMPORTANT:** position arguments of `getBv` functions have been flipped! First comes the source position POSm THEN the observer position POSo!
 
 ### Added
 - completed the library vector functionality adding magnet Cylinder, moment Dipole, current Circular and Line. This includes adding several private vectorized functions (e.g. ellipticV) to mathLib_vector, adding respective tests and docu examples.

docs/_pages/1_how2install.rst

@@ -5,7 +5,12 @@ Installation
 *************************
 
 .. warning::
-    Magpylib works only with Python 3.6 or later !
+    magpylib works only with Python 3.6 or later !
+    
+    **Dependencies:**
+        - numpy
+        - matplotlib
+    The latest versions will be installed automatically with magpylib.
 
 
 Content 

docs/index.rst

@@ -9,6 +9,7 @@ What is magpylib ?
 - Free Python package for calculating magnetic fields of magnets, currents and moments (sources).
 - Provides convenient methods to create, geometrically manipulate, group and visualize assemblies of sources.
 - The magnetic fields are determined from underlying (semi-analytical) solutions which results in fast computation times and requires little computation power.
+- For high performance computation (e.g. for multivariate parameter space analysis) all functions are also available in vectorized form.
 
 .. image:: _static/images/index/sourceFundamentals.png
    :align: center

setup.py

@@ -20,7 +20,7 @@
 
 _SphinxVersion = "1.8.2"
 _name = "magpylib"
-_description = "A simple Python 3 toolbox for calculating magnetic fields from permanent magnets and current distributions."
+_description = "Free Python3 package to compute magnetic fields."
 _author_email = "magpylib@gmail.com"
 _author = "Michael Ortner"
 _projectUrl = "https://github.com/magpylib/magpylib"

tests/test_fields/test_CurrentLine.py

@@ -1,7 +1,7 @@
-from magpylib._lib.fields.Current_Line import Bfield_CurrentLine
+from magpylib._lib.fields.Current_Line_vector import Bfield_CurrentLineV
 from numpy import array
 import pytest
-
+import numpy as np
 
 # -------------------------------------------------------------------------------
 def test_Bfield_Zero_Length_segment():
@@ -13,12 +13,13 @@ def test_Bfield_Zero_Length_segment():
     pos = [0,0,0]
 
     vertices = array([[-1,0,0],[1,0,5],[1,0,5]])
-    with pytest.warns(RuntimeWarning):
-        results=Bfield_CurrentLine(pos,vertices,current)
-        rounding = 4
+    
+    results=Bfield_CurrentLineV(vertices,current,pos)
+    rounding = 4
 
-        for i in range(0,3):
-            assert round(mockResult[i],rounding)==round(results[i],rounding), errMsg
+    for i in range(0,3):
+        assert round(mockResult[i],rounding)==round(results[i],rounding), errMsg
+    
 
 # -------------------------------------------------------------------------------
 def test_Bfield_CurrentLine_outside():
@@ -44,48 +45,24 @@ def test_Bfield_CurrentLine_outside():
     vertices = array([ [-4,-4,-3],[3.5,-3.5,-2],[3,3,-1],
                  [-2.5,2.5,0],[-2,-2,1],[1.5,-1.5,2],[1,1,3]])
 
-    results=[Bfield_CurrentLine(pos,vertices,current) for pos in testPosOut]
+    results=[Bfield_CurrentLineV(vertices,current,pos) for pos in testPosOut]
     rounding = 4
     for i in range(0,len(mockResults)):
         for j in range(0,3):
             assert round(mockResults[i][j],rounding)==round(results[i][j],rounding), errMsg
 
-# -------------------------------------------------------------------------------
-def test_Bfield_singularity():
-    # Test the result fo field sampleS on the line current
-    # Each origin vertix, collinear center point
-    # Expected: [nan,nan,nan]
-    from magpylib import source,Collection
-    from numpy import array, isnan
-    vertices = [array([1,2,2]),array([1,2,30])]
-    current = 5
-
-    origin1 = vertices[0]
-    origin2 = vertices[1]
-    middle = ((vertices[0]) + (vertices[1])) / 2
-
-    testPos = [origin1,origin2,middle]
-    with pytest.warns(RuntimeWarning):
-        results = [Bfield_CurrentLine(pos,vertices,current) for pos in testPos]
-        assert all(all(isnan(val) for val in result) for result in results), "Results from getB is not NaN"
-
 # -------------------------------------------------------------------------------
 def test_Bfield_onLine():
     # Check if points that are on the line but 
     # not on the segment still return valid results
     # Expected for collinear points: [0,0,0]
-    errMsg = "Points on Line (not on segment) are not being calculated"
-    from magpylib import source,Collection
-    from numpy import array
-    vertices = [array([1,2,2]),array([1,2,30])]
-    current = 5
-    mockResults = [[0.0, 0.0, 0.0], [0.0, 0.0, 0.0]]
 
-    points = [vertices[0] + [0,0,-3], vertices[1] + [0,0,3]]
+    vertices = np.array([[1,2,2],[1,2,30]])
+    current = 5
+    mockResults = np.zeros((2,3))
 
+    points = [vertices[0] + array([0,0,-3]), vertices[1] + array([0,0,3])] #on line
 
-    results = [Bfield_CurrentLine(point,vertices,current) for point in points]
-    rounding = 4
-    for i in range(0,len(mockResults)):
-        for j in range(0,3):
-            assert round(mockResults[i][j],rounding)==round(results[i][j],rounding), errMsg
+    results = array([Bfield_CurrentLineV(vertices,current,point) for point in points])
+    
+    assert np.all((results==mockResults).ravel())