Merged in getters_to_properties (pull request #201)

Getters to properties Approved-by: Bradley Dice <bdice@bradleydice.com> Approved-by: Vyas Ramasubramani <vramasub@umich.edu>
glotzerlab · Aug 24, 2018 · ad7db6a · ad7db6a
2 parents 333ad89 + 9683ab8
commit ad7db6a
Show file tree

Hide file tree

Showing 29 changed files with 1,661 additions and 1,825 deletions.
diff --git a/doc/source/bond.rst b/doc/source/bond.rst
@@ -19,21 +19,16 @@ Bond Module
     :synopsis: Calculate bonds
 
 .. autoclass:: freud.bond.BondingAnalysis(num_particles, num_bonds)
-    :members:
-    :inherited-members:
+    :members: compute, initialize
 
 .. autoclass:: freud.bond.BondingR12(r_max, bond_map, bond_list)
-    :members:
-    :inherited-members:
+    :members: compute
 
 .. autoclass:: freud.bond.BondingXY2D(x_max, y_max, bond_map, bond_list)
-    :members:
-    :inherited-members:
+    :members: compute
 
 .. autoclass:: freud.bond.BondingXYT(x_max, y_max, bond_map, bond_list)
-    :members:
-    :inherited-members:
+    :members: compute
 
 .. autoclass:: freud.bond.BondingXYZ(x_max, y_max, z_max, bond_map, bond_list)
-    :members:
-    :inherited-members:
+    :members: compute
diff --git a/doc/source/box.rst b/doc/source/box.rst
@@ -15,5 +15,4 @@ Box Module
     :synopsis: Represent periodic boxes
 
 .. autoclass:: freud.box.Box(Lx, Ly, Lz, xy, xz, yz, is2D=None)
-    :members:
-    :inherited-members:
+    :members: cube, from_box, from_matrix, getCoordinates, getImage, getLatticeVector, is2D, makeFraction, square, to_dict, to_matrix, to_tuple, unwrap, wrap
diff --git a/doc/source/cluster.rst b/doc/source/cluster.rst
@@ -16,7 +16,7 @@ Cluster Module
     :synopsis: Find clusters
 
 .. autoclass:: freud.cluster.Cluster(box, rcut)
-    :members:
+    :members: computeClusterMembership, computeClusters
 
 .. autoclass:: freud.cluster.ClusterProperties(box)
-    :members:
+    :members: computeProperties
diff --git a/doc/source/density.rst b/doc/source/density.rst
@@ -22,25 +22,25 @@ Correlation Functions
 =====================
 
 .. autoclass:: freud.density.FloatCF(rmax, dr)
-    :members:
+    :members: accumulate, compute, reset
 
 .. autoclass:: freud.density.ComplexCF(rmax, dr)
-    :members:
+    :members: accumulate, compute, reset
 
 Gaussian Density
 ================
 
-.. autoclass:: freud.density.GaussianDensity(*args)
-    :members:
+.. autoclass:: freud.density.GaussianDensity(\*args)
+    :members: compute
 
 Local Density
 =============
 
 .. autoclass:: freud.density.LocalDensity(r_cut, volume, diameter)
-    :members:
+    :members: compute
 
 Radial Distribution Function
 ============================
 
 .. autoclass:: freud.density.RDF(rmax, dr, rmin=0)
-    :members:
+    :members: accumulate, compute, reset
diff --git a/doc/source/environment.rst b/doc/source/environment.rst
@@ -21,20 +21,19 @@ Environment Module
     :synopsis: Analyze local particle environments
 
 .. autoclass:: freud.environment.BondOrder(rmax, k, n, nBinsT, nBinsP)
-    :members:
+    :members: accumulate, compute, reset
 
 .. autoclass:: freud.environment.LocalDescriptors(box, nNeigh, lmax, rmax)
-    :members:
+    :members: compute, computeNList
 
 .. autoclass:: freud.environment.MatchEnv(box, rmax, k)
-    :members:
+    :members: cluster, getEnvironment, isSimilar, matchMotif, minRMSDMotif, minimizeRMSD, setBox
 
 .. note::
     Pairing2D is deprecated and is replaced with :doc:`bond`.
 
 .. autoclass:: freud.environment.Pairing2D(rmax, k, compDotTol)
-    :members:
+    :members: compute
 
 .. autoclass:: freud.environment.AngularSeparation(box, rmax, n)
-    :members:
-
+    :members: computeGlobal, computeNeighbor
diff --git a/doc/source/kspace.rst b/doc/source/kspace.rst
@@ -83,4 +83,4 @@ Utilities
 
 .. autofunction:: freud.kspace.reciprocalLattice3D()
 
-.. autofunction:: freud.kspace.meshgrid2(*arrs)
+.. autofunction:: freud.kspace.meshgrid2
diff --git a/doc/source/locality.rst b/doc/source/locality.rst
@@ -24,7 +24,7 @@ Locality Module
    :members:
 
 .. autoclass:: freud.locality.LinkCell(box, cell_width)
-   :members:
+   :members: compute, computeCellList, getCell, getCellNeighbors, itercell
 
 .. autoclass:: freud.locality.NearestNeighbors(rmax, n_neigh, scale=1.1, strict_cut=False)
-   :members:
+   :members: compute, getNeighborList, getNeighbors, getRsq, setCutMode
diff --git a/doc/source/order.rst b/doc/source/order.rst
@@ -29,34 +29,34 @@ Order Module
     :synopsis: Compute order parameters
 
 .. autoclass:: freud.order.CubaticOrderParameter(t_initial, t_final, scale, n_replicates, seed)
-    :members:
+    :members: compute
 
 .. autoclass:: freud.order.NematicOrderParameter(u)
-    :members:
+    :members: compute
 
 .. autoclass:: freud.order.HexOrderParameter(rmax, k, n)
-    :members:
+    :members: compute
 
 .. autoclass:: freud.order.TransOrderParameter(rmax, k, n)
-    :members:
+    :members: compute
 
 .. autoclass:: freud.order.LocalQl(box, rmax, l, rmin)
-    :members:
+    :members: compute, computeAve, computeAveNorm, computeNorm, setBox
 
 .. autoclass:: freud.order.LocalQlNear(box, rmax, l, kn)
-    :members:
+    :members: compute, computeAve, computeAveNorm, computeNorm, setBox
 
 .. autoclass:: freud.order.LocalWl(box, rmax, l)
-    :members:
+    :members: compute, computeAve, computeAveNorm, computeNorm, setBox
 
 .. autoclass:: freud.order.LocalWlNear(box, rmax, l, kn)
-    :members:
+    :members: compute, computeAve, computeAveNorm, computeNorm, setBox
 
 .. autoclass:: freud.order.SolLiq(box, rmax, Qthreshold, Sthreshold, l)
-    :members:
+    :members: compute, computeSolLiqNoNorm, computeSolLiqVariant
 
 .. autoclass:: freud.order.SolLiqNear(box, rmax, Qthreshold, Sthreshold, l)
-    :members:
+    :members: compute, computeSolLiqNoNorm, computeSolLiqVariant
 
 Deprecated Classes
 ==================
@@ -67,19 +67,16 @@ Bond Order
 ----------
 
 .. autoclass:: freud.order.BondOrder(rmax, k, n, nBinsT, nBinsP)
-    :members:
 
 Local Descriptors
 -----------------
 
 .. autoclass:: freud.order.LocalDescriptors(box, nNeigh, lmax, rmax)
-    :members:
 
 Environment Matching
 --------------------
 
 .. autoclass:: freud.order.MatchEnv(box, rmax, k)
-    :members:
 
 Pairing
 -------
@@ -88,10 +85,8 @@ Pairing
     Pairing2D is deprecated and is replaced with :doc:`bond`.
 
 .. autoclass:: freud.order.Pairing2D(rmax, k, compDotTol)
-    :members:
 
 Angular Separation
 ------------------
 
 .. autoclass:: freud.order.AngularSeparation(box, rmax, n)
-    :members:
diff --git a/doc/source/pmft.rst b/doc/source/pmft.rst
@@ -18,17 +18,13 @@ PMFT Module
     :synopsis: Compute potentials of mean force and torque
 
 .. autoclass:: freud.pmft.PMFTR12(r_max, n_r, n_t1, n_t2)
-    :members:
-    :inherited-members:
+    :members: accumulate, compute, reset
 
 .. autoclass:: freud.pmft.PMFTXYT(x_max, y_max, n_x, n_y, n_t)
-    :members:
-    :inherited-members:
+    :members: accumulate, compute, reset
 
 .. autoclass:: freud.pmft.PMFTXY2D(x_max, y_max, n_x, n_y)
-    :members:
-    :inherited-members:
+    :members: accumulate, compute, reset
 
 .. autoclass:: freud.pmft.PMFTXYZ(x_max, y_max, z_max, n_x, n_y, n_z)
-    :members:
-    :inherited-members:
+    :members: accumulate, compute, reset
diff --git a/doc/source/voronoi.rst b/doc/source/voronoi.rst
@@ -13,8 +13,9 @@ Voronoi Module
 
 .. automodule:: freud.voronoi
     :synopsis: Characterize Voronoi cells
-    :members:
 
 .. autoclass:: freud.voronoi.Voronoi(box, buff)
-    :members:
+    :members: compute, computeNeighbors, computeVolumes, getNeighborList, getNeighbors, getVolumes, getVoronoiPolytopes, setBox, setBufferWidth
 
+.. autoclass:: freud.voronoi.VoronoiBuffer(box)
+    :members: compute