Rename skyrmion_number_at_centre to skyrmion_number_centre_slice (will change

again soon, you'll see what I have in mind!)

Author: mvousden

fidimag/atomistic/llg.py

@@ -298,7 +298,7 @@ def skyrmion_number(self):
             self.spin, self._skx_number, nx, ny, nz, self.mesh.neighbours)
         return number
 
-    skyrmion_number_centre = fidimag.common.skyrmion_number.skyrmion_number_at_centre
+    skyrmion_number_centre_slice = fidimag.common.skyrmion_number.skyrmion_number_centre_slice
     skyrmion_number_lee = fidimag.common.skyrmion_number.skyrmion_number_lee
 
     def spin_at(self, i, j, k):

fidimag/common/skyrmion_number.py

@@ -3,7 +3,7 @@
 import numpy as np
 
 
-def skyrmion_number_at_centre(sim):
+def skyrmion_number_centre_slice(sim):
     """
     Returns the skyrmion number calculated on the x-y plane at the central z
     co-ordinate.

fidimag/common/skyrmion_number_test.py

@@ -1,4 +1,4 @@
-from fidimag.common.skyrmion_number import skyrmion_number_at_centre
+from fidimag.common.skyrmion_number import skyrmion_number_centre_slice
 from fidimag.common.skyrmion_number import skyrmion_number_lee
 import copy
 import fidimag
@@ -177,7 +177,7 @@ def test_skyrmion_number_monolayer():
     clibSk = testCase.microSim.skyrmion_number()
     print("CLib calculates the skyrmion number as: {:1.2f}.".format(clibSk))
 
-    centreSk = testCase.microSim.skyrmion_number_centre()
+    centreSk = testCase.microSim.skyrmion_number_centre_slice()
     print("I calculate the skyrmion number at the centre as: {:1.2f}."
           .format(centreSk))
 
@@ -195,7 +195,7 @@ def test_skyrmion_number_monolayer():
     clibSk = testCase.atomSim.skyrmion_number()
     print("CLib calculates the skyrmion number as: {:1.2f}.".format(clibSk))
 
-    centreSk = testCase.atomSim.skyrmion_number_centre()
+    centreSk = testCase.atomSim.skyrmion_number_centre_slice()
     print("I calculate the skyrmion number at the centre as: {:1.2f}."
           .format(centreSk))
 
@@ -229,7 +229,7 @@ def test_skyrmion_number_multilayer():
     clibSk = testCase.microSim.skyrmion_number()
     print("CLib calculates the skyrmion number as: {:1.2f}.".format(clibSk))
 
-    centreSk = testCase.microSim.skyrmion_number_centre()
+    centreSk = testCase.microSim.skyrmion_number_centre_slice()
     print("I calculate the skyrmion number at the centre as: {:1.2f}."
           .format(centreSk))
 
@@ -247,7 +247,7 @@ def test_skyrmion_number_multilayer():
     clibSk = testCase.atomSim.skyrmion_number()
     print("CLib calculates the skyrmion number as: {:1.2f}.".format(clibSk))
 
-    centreSk = testCase.atomSim.skyrmion_number_centre()
+    centreSk = testCase.atomSim.skyrmion_number_centre_slice()
     print("I calculate the skyrmion number at the centre as: {:1.2f}."
           .format(centreSk))
 

fidimag/micro/llg.py

@@ -310,7 +310,7 @@ def skyrmion_number(self):
             self.spin, self._skx_number, nx, ny, nz, self.mesh.neighbours)
         return number
 
-    skyrmion_number_centre = fidimag.common.skyrmion_number.skyrmion_number_at_centre
+    skyrmion_number_centre_slice = fidimag.common.skyrmion_number.skyrmion_number_centre_slice
     skyrmion_number_lee = fidimag.common.skyrmion_number.skyrmion_number_lee
 
     def spin_at(self, i, j, k):