automatic documentation for some post processing scripts

.gitlab-ci.yml

@@ -496,6 +496,27 @@ Spectral:
   only:
     - development
 
+Processing:
+  stage: createDocumentation
+  script:
+    - cd $DAMASKROOT/processing/post
+    - $DAMASKROOT/PRIVATE/documenting/scriptHelpToWiki.py
+      addAPS34IDEstrainCoords.py
+      addCauchy.py addCumulative.py addCurl.py
+      addDerivative.py addDeterminant.py addDeviator.py addDivergence.py
+      addEhkl.py
+      addGradient.py
+      addIndexed.py
+      addInfo.py
+      addLinked.py
+      addMises.py
+      addNorm.py
+      addPK2.py
+      addSpectralDecomposition.py addStrainTensors.py > post.html
+  except:
+    - master
+    - release
+
 ##################################################################################################
 backupData:
   stage: saveDocumentation

PRIVATE

@@ -1 +1 @@
-Subproject commit beb9682fff7d4d6c65aba12ffd04c7441dc6ba6b
+Subproject commit 30434a528f69d77eef1be91e8a2f2fc5e0f85054

processing/post/addAPS34IDEstrainCoords.py

@@ -19,15 +19,10 @@ Transform X,Y,Z,F APS BeamLine 34 coordinates to x,y,z APS strain coordinates.
 
 """, version = scriptID)
 
-parser.add_option('-f',
+parser.add_option('-f','--frame',dest='frame', nargs=3, metavar='string string string',
-                  '--frame',
+                                 help='APS X,Y,Z coords')
-                  dest='frame',
+parser.add_option('--depth',     dest='depth',          metavar='string',
-                  metavar='string',
+                                 help='depth')
-                  help='APS X,Y,Z coords')
-parser.add_option('--depth',
-                  dest='depth',
-                  metavar='string',
-                  help='depth')
 
 (options,filenames) = parser.parse_args()
 

processing/post/addCurl.py

@@ -49,7 +49,7 @@ def curlFFT(geomdim,field):
 
   curl_fourier = np.einsum(einsums[n],e,k_s,field_fourier)*TWOPIIMG
 
-  return np.fft.irfftn(curl_fourier,s=shapeFFT,axes=(0,1,2)).reshape([N,n])
+  return np.fft.irfftn(curl_fourier,axes=(0,1,2),s=shapeFFT).reshape([N,n])
 
 
 # --------------------------------------------------------------------

processing/post/addDivergence.py

@@ -45,7 +45,7 @@ def divFFT(geomdim,field):
 
   div_fourier = np.einsum(einsums[n],k_s,field_fourier)*TWOPIIMG
 
-  return np.fft.irfftn(div_fourier,s=shapeFFT,axes=(0,1,2)).reshape([N,n//3])
+  return np.fft.irfftn(div_fourier,axes=(0,1,2),s=shapeFFT).reshape([N,n/3])
 
 
 # --------------------------------------------------------------------

processing/post/addGradient.py

@@ -45,7 +45,7 @@ def gradFFT(geomdim,field):
   k_s = np.concatenate((ki[:,:,:,None],kj[:,:,:,None],kk[:,:,:,None]),axis = 3).astype('c16')                           
   grad_fourier = np.einsum(einsums[n],field_fourier,k_s)*TWOPIIMG
 
-  return np.fft.irfftn(grad_fourier,s=shapeFFT,axes=(0,1,2)).reshape([N,3*n])
+  return np.fft.irfftn(grad_fourier,axes=(0,1,2),s=shapeFFT).reshape([N,3*n])
 
 
 # --------------------------------------------------------------------