references update

Author: Tomás Méndez Echenagucia

src/compas/com/matlab_/engine.py

@@ -27,7 +27,8 @@ def __init__(self, message=None):
 
 
 class MatlabEngine(object):
-    """Communicate with Matlab through the MATLAB engine.
+    """Communicate with Matlab through the MATLAB engine [mathworks2017a]_, [mathworks2017b]_,
+        [mathworks2017c]_, [mathworks2017d]_, [mathworks2017e]_.
 
     Attributes
     ----------
@@ -43,14 +44,6 @@ class MatlabEngine(object):
     >>> matlab.engine.isprime(37)
     True
 
-    References
-    ----------
-    * `MATLAB Engine API for Python <https://ch.mathworks.com/help/matlab/matlab-engine-for-python.html>`_
-    * `Pass Data to MATLAB from Python <https://ch.mathworks.com/help/matlab/matlab_external/pass-data-to-matlab-from-python.html>`_
-    * `Use MATLAB Arrays in Python <https://ch.mathworks.com/help/matlab/matlab_external/use-matlab-arrays-in-python.html>`_
-    * `Use MATLAB Engine Workspace in Python <https://ch.mathworks.com/help/matlab/matlab_external/use-the-matlab-engine-workspace-in-python.html>`_
-    * `Call MATLAB Functions from Python <https://ch.mathworks.com/help/matlab/matlab_external/call-matlab-functions-from-python.html>`_
-
     """
 
     def __init__(self):

src/compas/datastructures/volmesh/volmesh.py

@@ -66,8 +66,8 @@ class VolMesh(FromToData,
 
     Volumetric meshes are 3-mainfold, cellular structures.
 
-    The implementation of ``VolMesh`` is based on the notion of *x-maps* [xmaps]
-    and the concepts behind the *OpenVolumeMesh* library [ovm].
+    The implementation of ``VolMesh`` is based on the notion of *x-maps*
+    and the concepts behind the *OpenVolumeMesh* library [vci2016]_.
     In short, we add an additional entity compared to polygonal meshes,
     the *cell*, and relate cells not through *half-edges*, but through a combination
     of *half-faces* and *planes*. Each cell consists of a series of vertex pairs,
@@ -92,7 +92,7 @@ class VolMesh(FromToData,
         halffaces.
         ``self.cell[ckey][u][v] -> fkey``
     halfface : dict
-        The halffaces of the volmesh. Each halfface is represented by 
+        The halffaces of the volmesh. Each halfface is represented by
         ``self.halfface[fkey] -> vertex cycle``
     plane : dict
         The planes of the volmesh. Every plane is uniquely defined by three
@@ -104,11 +104,6 @@ class VolMesh(FromToData,
         pointing at the cells of the volmesh.
         ``self.plane[u][v][w] -> ckey``.
 
-    References
-    ----------
-    .. [xmaps] xxx
-    .. [ovm] `Open Volum Mesh <http://www.openvolumemesh.org>`_
-
     """
 
     def __init__(self):
@@ -888,5 +883,5 @@ def scale(self, factor=1.0):
 
     viewer.setup()
 
-    viewer.camera.zoom_out(5)    
+    viewer.camera.zoom_out(5)
     viewer.show()

src/compas/files/obj.py

@@ -40,7 +40,7 @@ def __init__(self, filepath, remote=False, precision=None):
 
 
 class OBJReader(object):
-    """Read the contents of an *obj* file.
+    """Read the contents of an *obj* file [Bourke]_.
 
     Parameters:
         filepath (str): Path to the file.
@@ -61,9 +61,6 @@ class OBJReader(object):
         curves2 (list): Curves
         surfaces (list): Surfaces
 
-    References:
-        http://paulbourke.net/dataformats/obj/
-
     """
 
     def __init__(self, filepath, remote=False):

src/compas/geometry/algorithms/bestfit.py

@@ -29,7 +29,7 @@
 
 
 def bestfit_plane(points):
-    """Fit a plane to a list of (more than three) points.
+    """Fit a plane to a list of (more than three) points [Ernerfeldt2015]_.
 
     Parameters
     ----------
@@ -41,10 +41,6 @@ def bestfit_plane(points):
     plane : tuple
         Base point and normal vector (normalized).
 
-    References
-    ----------
-    http://www.ilikebigbits.com/blog/2015/3/2/plane-from-points
-
     Warning
     -------
     This method will minimize the squares of the residuals as perpendicular
@@ -210,7 +206,7 @@ def bestfit_plane_numpy4(points):
 
 
 def bestfit_circle_numpy(points):
-    """Fit a circle through a set of points.
+    """Fit a circle through a set of points [Scipya]_.
 
     Warning
     -------
@@ -233,11 +229,6 @@ def bestfit_circle_numpy(points):
 
         #
 
-
-    References
-    ----------
-    * http://scipy-cookbook.readthedocs.io/items/Least_Squares_Circle.html
-
     """
     from numpy import sqrt
     from numpy import mean

src/compas/geometry/algorithms/hull.py

@@ -25,7 +25,7 @@
 
 
 def convex_hull(points):
-    """Construct convex hull for a set of points.
+    """Construct convex hull for a set of points [githubgist_a]_.
 
     Parameters
     ----------
@@ -77,9 +77,6 @@ def convex_hull(points):
                     show_vertices = False,
                     show_edges = False)
 
-    References
-    ----------
-    * https://gist.github.com/anonymous/5184ba0bcab21d3dd19781efd3aae543
 
     """
     def _normal_face(face):
@@ -118,7 +115,7 @@ def _add_point(hull, p):
 
 
 def convex_hull_xy(points):
-    """Computes the convex hull of a set of 2D points.
+    """Computes the convex hull of a set of 2D points [wikibooks2017]_.
 
     Note
     ----
@@ -139,9 +136,6 @@ def convex_hull_xy(points):
         XY(Z) coordinates of vertices of the convex hull in counter-clockwise order,
         starting from the vertex with the lexicographically smallest coordinates.
 
-    References
-    ----------
-    * https://en.wikibooks.org/wiki/Algorithm_Implementation/Geometry/Convex_hull/Monotone_chain
 
     """
 

src/compas/geometry/algorithms/interpolation.py

@@ -22,7 +22,7 @@
 
 def discrete_coons_patch(ab, bc, dc, ad):
     """Creates a coons patch from a set of four or three boundary
-    polylines (ab, bc, dc, ad).
+    polylines (ab, bc, dc, ad) [wikipedia2017]_, [ferreol2013]_.
 
     Direction and order of polylines::
 
@@ -61,11 +61,6 @@ def discrete_coons_patch(ab, bc, dc, ad):
     --------
     * :func:`compas.datastructures.mesh_cull_duplicate_vertices`
 
-    References
-    ----------
-    * https://en.wikipedia.org/wiki/Coons_patch
-    * https://www.mathcurve.com/surfaces/patchcoons/patchcoons.shtml
-
     """
     if not ab:
         ab = [ad[0]] * len(dc)

src/compas/geometry/basic.py

@@ -1103,7 +1103,7 @@ def plane_from_points(a, b, c):
 
 
 def circle_from_points(a, b, c):
-    """Construct a circle from three points.
+    """Construct a circle from three points [wikipedia2017b]_.
 
     Parameters
     ----------
@@ -1119,10 +1119,6 @@ def circle_from_points(a, b, c):
     circle : tuple
         Center, radius, normal  of the circle.
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Circumscribed_circle
-
     Examples
     --------
     >>>
@@ -1148,7 +1144,7 @@ def circle_from_points(a, b, c):
 
 
 def circle_from_points_xy(a, b, c):
-    """Create a circle from three points lying in the XY-plane.
+    """Create a circle from three points lying in the XY-plane [wikipedia2017b]_
 
     Parameters
     ----------
@@ -1164,10 +1160,6 @@ def circle_from_points_xy(a, b, c):
     tuple
         XYZ coordinates of center in the XY-plane (Z = 0.0) and radius of the circle.
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Circumscribed_circle
-
     Examples
     --------
     >>>

src/compas/geometry/distance.py

@@ -173,7 +173,7 @@ def distance_point_point_sqrd_xy(a, b):
 
 
 def distance_point_line(point, line):
-    """Compute the distance between a point and a line.
+    """Compute the distance between a point and a line [wikipedia2017c]_.
 
     This implementation computes the *right angle distance* from a point P to a
     line defined by points A and B as twice the area of the triangle ABP divided
@@ -195,10 +195,6 @@ def distance_point_line(point, line):
     --------
     >>>
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line
-
     """
     a, b = line
     ab   = subtract_vectors(b, a)
@@ -210,7 +206,7 @@ def distance_point_line(point, line):
 
 
 def distance_point_line_xy(point, line):
-    """Compute the distance between a point and a line, assuming they lie in the XY-plane.
+    """Compute the distance between a point and a line, assuming they lie in the XY-plane [wikipedia2017c]_.
 
     This implementation computes the orthogonal distance from a point P to a
     line defined by points A and B as twice the area of the triangle ABP divided
@@ -228,10 +224,6 @@ def distance_point_line_xy(point, line):
     float
         The distance between the point and the line.
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line
-
     """
     a, b = line
     ab   = subtract_vectors_xy(b, a)
@@ -243,7 +235,7 @@ def distance_point_line_xy(point, line):
 
 
 def distance_point_line_sqrd(point, line):
-    """Compute the squared distance between a point and a line.
+    """Compute the squared distance between a point and a line [wikipedia2017c]_.
 
     Parameters
     ----------
@@ -257,9 +249,6 @@ def distance_point_line_sqrd(point, line):
     float
         The squared distance between the point and the line.
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line
 
     """
     a, b = line
@@ -272,7 +261,7 @@ def distance_point_line_sqrd(point, line):
 
 
 def distance_point_line_sqrd_xy(point, line):
-    """Compute the squared distance between a point and a line lying in the XY-plane.
+    """Compute the squared distance between a point and a line lying in the XY-plane [wikipedia2017c]_.
 
     This implementation computes the orthogonal squared distance from a point P to a
     line defined by points A and B as twice the area of the triangle ABP divided
@@ -290,10 +279,6 @@ def distance_point_line_sqrd_xy(point, line):
     float
         The squared distance between the point and the line.
 
-    References
-    ----------
-    https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line
-
     """
     a, b = line
     ab   = subtract_vectors_xy(b, a)
@@ -305,7 +290,7 @@ def distance_point_line_sqrd_xy(point, line):
 
 
 def distance_point_plane(point, plane):
-    r"""Compute the distance from a point to a plane defined by three points.
+    r"""Compute the distance from a point to a plane defined by three points [nykamp2012]_.
 
     The distance from a pioint to a planbe can be computed from the coefficients
     of the equation of the plane and the coordinates of the point.
@@ -350,18 +335,14 @@ def distance_point_plane(point, plane):
     --------
     >>>
 
-    References
-    ----------
-    http://mathinsight.org/distance_point_plane
-
     """
     base, normal = plane
     vector = subtract_vectors(point, base)
     return fabs(dot_vectors(vector, normal))
 
 
 def distance_line_line(l1, l2, tol=0.0):
-    """Compute the shortest distance between two lines.
+    """Compute the shortest distance between two lines [wisstein2017]_, [wikipedia2017d]_.
 
     The distance is the absolute value of the dot product of a unit vector that
     is perpendicular to the two lines, and the vector between two points on the lines.
@@ -386,11 +367,6 @@ def distance_line_line(l1, l2, tol=0.0):
     --------
     >>>
 
-    References
-    ----------
-    http://mathworld.wolfram.com/Line-LineDistance.html
-    https://en.wikipedia.org/wiki/Skew_lines#Distance
-
     """
     a, b = l1
     c, d = l2
@@ -763,7 +739,7 @@ def closest_point_on_polygon_xy(point, polygon):
 
 def closest_point_on_plane(point, plane):
     """
-    Compute closest point on a plane to a given point.
+    Compute closest point on a plane to a given point [wikipedia2017e]_.
 
     Parameters
     ----------
@@ -783,10 +759,6 @@ def closest_point_on_plane(point, plane):
     >>> point = [1.0, 2.0, 3.0]
     >>> closest_point_on_plane(point, plane)
 
-    References
-    ----------
-    http://en.wikipedia.org/wiki/Distance_from_a_point_to_a_plane
-
     """
     base, normal = plane
     x, y, z = base