clean up the html build

This commit is contained in:
Lindsey Heagy
2016-01-31 13:22:36 -08:00
parent 2874e204ee
commit 841ba61006
6 changed files with 28 additions and 16 deletions
+4 -2
View File
@@ -197,9 +197,10 @@ class BaseTensorMesh(BaseMesh):
Determines if a set of points are inside a mesh.
:param numpy.ndarray pts: Location of points to test
:rtype numpy.ndarray
:return inside, numpy array of booleans
:rtype numpy.ndarray:
:return inside, numpy array of booleans:
"""
pts = Utils.asArray_N_x_Dim(pts, self.dim)
tensors = self.getTensor(locType)
@@ -234,6 +235,7 @@ class BaseTensorMesh(BaseMesh):
'N' -> scalar field defined on nodes
'CC' -> scalar field defined on cell centers
"""
if self._meshType == 'CYL' and self.isSymmetric and locType in ['Ex','Ez','Fy']:
raise Exception('Symmetric CylMesh does not support %s interpolation, as this variable does not exist.' % locType)
+9 -7
View File
@@ -321,13 +321,15 @@ def writeVTRFile(fileName,mesh,model=None):
def ExtractCoreMesh(xyzlim, mesh, meshType='tensor'):
"""
Extracts Core Mesh from Global mesh
xyzlim: 2D array [ndim x 2]
mesh: SimPEG mesh
This function ouputs:
- actind: corresponding boolean index from global to core
- meshcore: core SimPEG mesh
Warning: 1D and 2D has not been tested
Extracts Core Mesh from Global mesh
xyzlim: 2D array [ndim x 2]
mesh: SimPEG mesh
This function ouputs:
- actind: corresponding boolean index from global to core
- meshcore: core SimPEG mesh
Warning: 1D and 2D has not been tested
"""
from SimPEG import Mesh
if mesh.dim ==1:
+2
View File
@@ -46,6 +46,8 @@ The API
=======
.. autofunction:: SimPEG.Utils.SolverUtils.SolverWrapD
:noindex:
.. autofunction:: SimPEG.Utils.SolverUtils.SolverWrapI
:noindex:
+8 -3
View File
@@ -21,7 +21,7 @@ Solver Utilities
:undoc-members:
Curv Utilities
=============
==============
.. automodule:: SimPEG.Utils.curvutils
:members:
@@ -51,7 +51,9 @@ Interpolation Utilities
Counter Utilities
=================
::
.. code-block:: python
:linenos:
class MyClass(object):
def __init__(self, url):
self.counter = Counter()
@@ -68,8 +70,9 @@ Counter Utilities
for i in range(100): c.MyMethod()
for i in range(300): c.MySecondMethod()
c.counter.summary()
::
.. code-block:: none
Counters:
MyClass.MyMethod : 100
@@ -77,6 +80,8 @@ Counter Utilities
Times: mean sum
MyClass.MySecondMethod : 1.70e-06, 5.10e-04, 300x
The API
-------
+2 -2
View File
@@ -67,7 +67,7 @@ release = '0.1.9'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build','_static']
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -129,7 +129,7 @@ except Exception, e:
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
+3 -2
View File
@@ -35,13 +35,14 @@ Here we reproduce the results from Celia et al. (1990):
.. plot::
from SimPEG.FLOW.Examples import Celia1990
from SimPEG.Examples import FLOW_Richards_1D_Celia1990 as Celia1990
Celia1990.run()
Richards
========
.. automodule:: simpegFLOW.Richards.Empirical
.. automodule:: SimPEG.FLOW.Richards.Empirical
:show-inheritance:
:members:
:undoc-members: