Merge pull request #62 from ubermag/correction

corrections
ubermag · May 9, 2024 · 4938524 · 4938524
2 parents 3f67ff6 + 1a8efbf
commit 4938524
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 60 deletions.
diff --git a/micromagneticdata/abstract_drive.py b/micromagneticdata/abstract_drive.py
@@ -60,8 +60,7 @@ def x(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Data(name='hysteresis', dirname=dirname)[0]
         >>> drive.x
         'B_hysteresis'
@@ -100,8 +99,7 @@ def m0(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.m0
         Field(...)
@@ -136,8 +134,7 @@ def table(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.table  # doctest: +SKIP
         E...
@@ -163,8 +160,7 @@ def n(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.n
         25
@@ -193,8 +189,7 @@ def __getitem__(self, item):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive[5]
         Field(...)
@@ -230,8 +225,7 @@ def __iter__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> list(drive)
         [...]
@@ -284,8 +278,7 @@ def __lshift__(self, other):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive_0 = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive_1 = md.Drive(name='system_name', number=1, dirname=dirname)
         >>> drive_0 << drive_1
@@ -338,8 +331,7 @@ def to_xarray(self, *args, **kwargs):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> xr_drive = drive.to_xarray(name='Mag')
         >>> xr_drive
@@ -416,8 +408,7 @@ def hv(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.hv(kdims=['x', 'y'])
         :DynamicMap...

diff --git a/micromagneticdata/combined_drive.py b/micromagneticdata/combined_drive.py
@@ -40,8 +40,7 @@ class CombinedDrive(md.AbstractDrive):
     >>> import os
     >>> import micromagneticdata as md
     ...
-    >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-    ...                                'tests', 'test_sample')
+    >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
     >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
 
     """
@@ -91,8 +90,7 @@ def __repr__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive
         OOMMFDrive(...)
@@ -120,8 +118,7 @@ def info(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=6, dirname=dirname)
         >>> drive.info
         {...}

diff --git a/micromagneticdata/data.py b/micromagneticdata/data.py
@@ -38,8 +38,7 @@ class Data:
     >>> import os
     >>> import micromagneticdata as md
     ...
-    >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-    ...                                'tests', 'test_sample')
+    >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
     >>> data = md.Data(name='system_name', dirname=dirname)
 
     """
@@ -69,8 +68,7 @@ def __repr__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data
         Data(...)
@@ -99,8 +97,7 @@ def info(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data.info
            drive_number...
@@ -124,8 +121,7 @@ def n(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data.n
         7
@@ -158,8 +154,7 @@ def __getitem__(self, item):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data.n
         7
@@ -195,8 +190,7 @@ def __iter__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data.n
         7
@@ -232,8 +226,7 @@ def selector(self, description="drive", **kwargs):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> data = md.Data(name='system_name', dirname=dirname)
         >>> data.selector()
         BoundedIntText(...)

diff --git a/micromagneticdata/drive.py b/micromagneticdata/drive.py
@@ -63,8 +63,7 @@ class Drive(md.AbstractDrive):
     >>> import os
     >>> import micromagneticdata as md
     ...
-    >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-    ...                                'tests', 'test_sample')
+    >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
     >>> drive = md.Data(name='system_name', dirname=dirname)[0]
     >>> drive
     OOMMFDrive(...)
@@ -191,8 +190,7 @@ def __getitem__(self, item):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive[5]
         Field(...)
@@ -201,8 +199,7 @@ def __getitem__(self, item):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> selection = drive[:8:2]
         >>> selection
@@ -249,8 +246,7 @@ def info(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=6, dirname=dirname)
         >>> drive.info
         {...}
@@ -277,8 +273,7 @@ def calculator_script(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=6, dirname=dirname)
         >>> drive.calculator_script
         '# MIF 2...'
@@ -308,8 +303,7 @@ def ovf2vtk(self, dirname=None):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.ovf2vtk()
 
@@ -344,8 +338,7 @@ def slider(self, description="step", **kwargs):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive.slider()
         IntSlider(...)

diff --git a/micromagneticdata/mumax3drive.py b/micromagneticdata/mumax3drive.py
@@ -54,8 +54,7 @@ class Mumax3Drive(md.Drive):
     >>> import os
     >>> import micromagneticdata as md
     ...
-    >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-    ...                                'tests', 'test_sample')
+    >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
     >>> drive = md.Drive(name='system_name', number=1, dirname=dirname)
     >>> drive
     Mumax3Drive(...)
@@ -117,8 +116,7 @@ def __repr__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=1, dirname=dirname)
         >>> drive
         Mumax3Drive(name='system_name', number=1, dirname='...test_sample', x='t')

diff --git a/micromagneticdata/oommfdrive.py b/micromagneticdata/oommfdrive.py
@@ -52,8 +52,7 @@ class OOMMFDrive(md.Drive):
     >>> import os
     >>> import micromagneticdata as md
     ...
-    >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-    ...                                'tests', 'test_sample')
+    >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
     >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
 
     """
@@ -109,8 +108,7 @@ def __repr__(self):
         >>> import os
         >>> import micromagneticdata as md
         ...
-        >>> dirname = dirname=os.path.join(os.path.dirname(__file__),
-        ...                                'tests', 'test_sample')
+        >>> dirname = os.path.join(os.path.dirname(__file__), 'tests', 'test_sample')
         >>> drive = md.Drive(name='system_name', number=0, dirname=dirname)
         >>> drive
         OOMMFDrive(name='system_name', number=0, dirname='...test_sample', x='t')