Skip to content

Commit 33d8ba1

Browse files
committed
fix doc typos
1 parent 6677b89 commit 33d8ba1

File tree

6 files changed

+12
-13
lines changed

6 files changed

+12
-13
lines changed

docs/src/LowLevel.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ NumberOfBatches
414414
Number of batches for cell list construction: 8
415415
Number of batches for function mapping: 32
416416
```
417-
The construction of the cell lists is performed by creating copies of the data, and currently does not scale very well. Thus, no more than 8 batches are used by default, to avoid delays associated to data copying and gargabe collection. The number of batches of the mapping function uses an heuristic which currently limits somewhat the number of batches for small systems, when the overhead of spawning tasks is greater than the computation.
417+
The construction of the cell lists is performed by creating copies of the data, and currently does not scale very well. Thus, no more than 8 batches are used by default, to avoid delays associated to data copying and garbage collection. The number of batches of the mapping function uses an heuristic which currently limits somewhat the number of batches for small systems, when the overhead of spawning tasks is greater than the computation.
418418
Using more batches than threads for the function mapping is effective most times in avoiding uneven workload, but it may be a problem if the output to be reduced is too large, as the threaded version of the output contains `nbatches` copies of the output.
419419

420420
Using less batches than the number of threads also allows the efficient use of nested multi-threading, as the computations will only use the number of threads required, leaving the other threads available for other tasks.
@@ -557,7 +557,7 @@ For long-running computations, the user might want to see the progress. A progre
557557
```julia
558558
map_pairwise!(f,output,box,cl,show_progress=true)
559559
```
560-
whill print something like:
560+
will print something like:
561561
```julia-repl
562562
Progress: 43%|█████████████████ | ETA: 0:18:25
563563
```

docs/src/PeriodicSystems.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ u = map_pairwise((x,y,i,j,d2,u) -> energy(d2,u,masses), system)
5252
## Potential energy example
5353

5454
!!! note
55-
The `output` of the `CellListMap` computation may be of any kind. Most commonly, it is an energy, a set of forces, or other data type that can be represented either as a number, an array of numbers, or an array of vectors (`SVectors` in particular), such as arrays of forces.
55+
The `output` of the `CellListMap` computation may be of any kind. Most commonly, it is an energy, a set of forces, or other data type that can be represented either as a number, an array of numbers, or an array of vectors (`SVectors` in particular), such as an arrays of forces.
5656

5757
Additionally, the properties are frequently additive (the energy is the sum of the energy of the particles, or the forces are added by summation).
5858

@@ -265,7 +265,7 @@ If the `map_pairwise!` function will compute energy and/or forces in a iterative
265265

266266
### Updating coordinates
267267

268-
The coordinates can be updated (mutated, or the array of coordinates can change in size by pushing or deleting particles), simply by directly acessing the `xpositions` field of the system. The `xpositions` array is a `Vector` of `SVector` (from `StaticArrays`), with coordinates copied from the input array provided. Thus, the coordinates in the `PeriodicSystem` structure must be updated independently of updates in the original array of coordinates.
268+
The coordinates can be updated (mutated, or the array of coordinates can change in size by pushing or deleting particles), simply by directly accessing the `xpositions` field of the system. The `xpositions` array is a `Vector` of `SVector` (from `StaticArrays`), with coordinates copied from the input array provided. Thus, the coordinates in the `PeriodicSystem` structure must be updated independently of updates in the original array of coordinates.
269269

270270
Let us exemplify the interface with the computation of forces:
271271

@@ -539,7 +539,7 @@ The number of batches launched in parallel runs can be tunned by the
539539
`nbatches` keyword parameter of the `PeriodicSystem` constructor.
540540
By default, the number of batches is defined as heuristic function
541541
dependent on the number of particles, and possibly returns optimal
542-
values in most cases. For a detailed dicussion about this parameter,
542+
values in most cases. For a detailed discussion about this parameter,
543543
see [Number of batches](@ref Number-of-batches).
544544

545545
For example, to set the number of batches for cell list calculation
@@ -791,7 +791,7 @@ function update_forces!(x, y, i, j, d2, forces, cutoff)
791791
forces[j] -= dudr
792792
return forces
793793
end
794-
# Function that initializes the system: it is preferrable to initialize
794+
# Function that initializes the system: it is preferable to initialize
795795
# the system outside the function that performs the simulation, because
796796
# the system (data)type is defined on initialization. Initializing it outside
797797
# the simulation function avoids possible type-instabilities.

docs/src/ecosystem.md

-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ julia> function sum_sqr(x,sides,cutoff)
9090
)
9191
return sum_sqr
9292
end
93-
sum_sqr (generic function with 1 method)
9493
```
9594

9695
Note that we allow `cutoff` and `sides` to be converted to the same type of the input `x` of the function. For a simple call to the function this is inconsequential:

docs/src/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Since version `0.7.22`, a new simpler, higher level interface was introduced, th
2424

2525
### Cutoff-delimited neighbor lists
2626

27-
The user might be more confortable in using the package to compute the list of neighboring particles. A custom interface for this application is provided though the [Neighbor lists](@ref) interface.
27+
The user might be more comfortable in using the package to compute the list of neighboring particles. A custom interface for this application is provided though the [Neighbor lists](@ref) interface.
2828

2929
Note that, in general, neighbor lists are used to compute other pairwise dependent properties, and these can be, in principle, computed directly with `CellListMap` without the need to compute or store the lists of neighbors.
3030

docs/src/neighborlists.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ julia> neighborlist(x, 0.05; unitcell=[1.0 0.5; 0.5 1.0])
8888

8989
## In-place computation of neighbor lists
9090

91-
If neighbor lists are computed within a interative scenario, it is interesting preallocate all the necessary
91+
If neighbor lists are computed within a interactive scenario, it is interesting preallocate all the necessary
9292
data and just update the lists at every iteration. This can be achieved by constructing the `InPlaceNeighborList`
9393
object in advance. The performance gain of performing the operations in place might vary and may not be
9494
important for single runs, as the allocations do not dominate the computing time.
@@ -107,7 +107,7 @@ Current list buffer size: 0
107107
```
108108

109109
Note that the buffer size has size `0`. The first time the neighbor lists are computed, the list will
110-
be allocated. We will use the `neighborlist!` (with the bang) function, because it will effectivelly
110+
be allocated. We will use the `neighborlist!` (with the bang) function, because it will effectively
111111
mutate the `system`, by allocating all necessary data:
112112

113113
```julia-repl
@@ -143,8 +143,8 @@ julia> @time list = neighborlist!(system);
143143
- The `cutoff` and `unitcell` can be modified by providing additional keyword parameters
144144
to the `update!` function (for example `update!(system, x; cutoff=0.1)`).
145145
- Allocations can occur if the cutoff, unit cell, or number of particles change such
146-
that greater buffers are required. The number of allocations tend to disminish as
147-
the buffers become large enough to accomodate the possible variations of the computation.
146+
that greater buffers are required. The number of allocations tend to diminish as
147+
the buffers become large enough to accommodate the possible variations of the computation.
148148

149149
For parallel runs, the allocations are minimal, but some small auxiliary data is required for the
150150
launching of multiple threads. We illustrate here the convergence of the allocations to the

docs/src/python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ In [9]: i_inds, j_inds, d = cl.neighborlist_cross(x, y, 0.05, unitcell=np.array(
6161
```
6262

6363
!!! note
64-
The indexes of the particles the `i_inds` and `j_inds` arrays are 0-based, to conform the numpy array standard.
64+
The indexes of the particles the `i_inds` and `j_inds` arrays are 0-based, to conform the `numpy` array standard.
6565

6666
!!! tip
6767
To run the code multi-threaded, set the `JULIA_NUM_THREADS` environment variable before launching python:

0 commit comments

Comments
 (0)