Skip to content

Commit

Permalink
Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jngrad committed Jul 29, 2019
1 parent 6a233ab commit 66f5992
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 24 deletions.
20 changes: 11 additions & 9 deletions src/python/espressomd/cluster_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Cluster(ScriptInterfaceHelper):
Returns list of particle ids in the cluster
particles():
Returns an instance of ParticleSlice containing the paritlces in the cluster
Returns an instance of ParticleSlice containing the particles in the cluster
size():
Returns the number of particles in the cluster
Expand All @@ -42,9 +42,9 @@ class Cluster(ScriptInterfaceHelper):
fractal_dimension(dr=None):
estimates the cluster's fractal dimension by fitting the number of particles
:math:`n` in spheres of growing radius around the cetner of mass
:math:`n` in spheres of growing radius around the center of mass
to :math:`c*r_g^d`, where :math:`r_g` is the radius of gyration of the particles
witin the sphere, and :math:`d` is the fractal dimensoin.
within the sphere, and :math:`d` is the fractal dimension.
`dr`: Minimum increment for the radius of the spheres.
Return value: (fractal_dimension, mean_square_residual)
"""
Expand All @@ -61,7 +61,7 @@ def particles(self):
@script_interface_register
class ClusterStructure(ScriptInterfaceHelper):

"""Cluster structure of a simulation system, and access to cluster anaylsis
"""Cluster structure of a simulation system, and access to cluster analysis
Attributes
----------
Expand All @@ -70,9 +70,11 @@ class ClusterStructure(ScriptInterfaceHelper):
clusters: behaves like a read-only dictionary
Access to individual clusters in the cluster structure either via
cluster[i], wher i is a (non-consecutive) integer cluster id
or via iteration:
for pair in clusters:
cluster[i], where i is a (non-consecutive) integer cluster id
or via iteration::
for pair in clusters:
where pair contains the numeric id and the corresponding cluster object.
"""
Expand All @@ -92,7 +94,7 @@ def run_for_all_pairs(self):

def run_for_bonded_particles(self):
"""
Runts the cluster analysis, considering only pairs of particles connected ba a pair-bond.
Runs the cluster analysis, considering only pairs of particles connected by a pair-bond.
"""
return self.call_method("run_for_bonded_particles")
Expand Down Expand Up @@ -134,7 +136,7 @@ class Clusters:
* Number of clusters: len(clusters)
* Access a cluster via its id: clusters[id]
* Iterate over clusters:::
* Iterate over clusters::
for c in clusters:
Expand Down
12 changes: 6 additions & 6 deletions src/python/espressomd/collision_detection.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class CollisionDetection(ScriptInterfaceHelper):
# Do not allow setting of individual attributes
def __setattr__(self, *args, **kwargs):
raise Exception(
"Please et all parameters at once via collision_detection.set_params()")
"Please set all parameters at once via collision_detection.set_params()")

# Override to call validate after parameter update
def set_params(self, **kwargs):
Expand Down Expand Up @@ -76,13 +76,13 @@ class CollisionDetection(ScriptInterfaceHelper):
Particle type of the virtual sites being created on collision (virtual sites based modes)
part_type_to_be_glued : :obj:`int`
particle type for "glue_to_surface|" mode. See user guide.
particle type for "glue_to_surface" mode. See user guide.
part_type_to_attach_vs_to : :obj:`int`
particle type for "glue_to_surface|" mode. See user guide.
particle type for "glue_to_surface" mode. See user guide.
part_type_after_glueing : :obj:`int`
particle type for "glue_to_surface|" mode. See user guide.
particle type for "glue_to_surface" mode. See user guide.
distance_glued_particle_to_vs : :obj:`float`
Distance for "glue_to_surface" mode. See user guide.
Expand All @@ -103,7 +103,7 @@ class CollisionDetection(ScriptInterfaceHelper):
# Completeness of parameter set
if not (set(kwargs.keys()) == set(self._params_for_mode(kwargs["mode"]))):
raise Exception("Parameter set does not match mode. ", kwargs[
"mode"], "requries ", self._params_for_mode(kwargs["mode"]))
"mode"], "requires ", self._params_for_mode(kwargs["mode"]))

# Mode
kwargs["mode"] = self._int_mode[kwargs["mode"]]
Expand All @@ -118,7 +118,7 @@ class CollisionDetection(ScriptInterfaceHelper):
handle_errors("Validation of collision detection failed")

def get_parameter(self, name):
#"""Gets a single parameter from the collision detection."""
"""Gets a single parameter from the collision detection."""

res = super().get_parameter(name)
return self._convert_param(name, res)
Expand Down
2 changes: 1 addition & 1 deletion src/python/espressomd/comfixed.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ComFixed(ScriptInterfaceHelper):
Parameters
----------
types : array_like
List of types of which the center of mass
List of types for which the center of mass
should be fixed.
"""

Expand Down
8 changes: 4 additions & 4 deletions src/python/espressomd/interactions.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1829,9 +1829,9 @@ cdef class BondedInteraction:
"""
Base class for bonded interactions.
Either called with an interaction id, in which case, the interaction
will represent the bonded interaction as it is defined in Espresso core
Or called with keyword arguments describing a new interaction.
Either called with an interaction id, in which case the interaction
will represent the bonded interaction as it is defined in Espresso core,
or called with keyword arguments describing a new interaction.
"""

Expand Down Expand Up @@ -3428,7 +3428,7 @@ class BondedInteractions:
yield self[i]

def add(self, bonded_ia):
"""Add a bonded ia to the simulation>"""
"""Add a bonded ia to the simulation"""
self[bonded_ia_params.size()] = bonded_ia

def __getstate__(self):
Expand Down
2 changes: 1 addition & 1 deletion src/python/espressomd/pair_criteria.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class _PairCriterion(ScriptInterfaceHelper):

def decide(self, p1, p2):
"""Makes a decision based on the two particles specified.
p2,p2 : Instances of ParticleHandle or integers containing the particle id.
p1,p2 : Instances of ParticleHandle or integers containing the particle id.
"""
id1 = None
id2 = None
Expand Down
4 changes: 2 additions & 2 deletions src/python/espressomd/particle_data.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ cdef class ParticleHandle:
def __set__(self, _pos):
cdef double mypos[3]
check_type_or_throw_except(
_pos, 3, float, "Postion must be 3 floats")
_pos, 3, float, "Position must be 3 floats")
for i in range(3):
mypos[i] = _pos[i]
if place_particle(self._id, mypos) == -1:
Expand Down Expand Up @@ -1856,7 +1856,7 @@ Set quat and scalar dipole moment (dipm) instead.")
# done here. the code is from the pos:property of ParticleHandle
cdef double mypos[3]
check_type_or_throw_except(
P["pos"], 3, float, "Postion must be 3 floats.")
P["pos"], 3, float, "Position must be 3 floats.")
for i in range(3):
mypos[i] = P["pos"][i]
if place_particle(P["id"], mypos) == -1:
Expand Down
2 changes: 1 addition & 1 deletion src/python/espressomd/shapes.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ class Wall(Shape, ScriptInterfaceHelper):
class SimplePore(Shape, ScriptInterfaceHelper):

"""
Two parallel infinite planes, and a cylindrical orfice connecting them.
Two parallel infinite planes, and a cylindrical orifice connecting them.
The cylinder and the planes are connected by torus segments with an
adjustable radius.
Expand Down

0 comments on commit 66f5992

Please sign in to comment.