fix some typos

Author: m-fila

README.md

@@ -53,7 +53,7 @@ The following example demonstrates a simple use of the package:
 using HEPExampleProject
 using Random
 
-# define random number generator for reproducability
+# define random number generator for reproducibility
 RNG = Xoshiro(137)
 
 # Define some input parameters for the HEP process

src/constants.jl

@@ -1,7 +1,7 @@
 """
     ELECTRON_MASS
 
-The mass of the electron in its rest frame, given as 0.51099895000 MeV
+The mass of the electron in its rest frame, given as 0.51099895000 MeV.
 
 This value is taken from the PDG 2020 recommended values of the fundamental physical constants.
 
@@ -16,7 +16,7 @@ Base.@irrational ELECTRON_MASS 0.51099895000 BigFloat(0.51099895000) # MeV
 """
    MUON_MASS 
 
-The mass of the muon in its rest frame, given as 105.6583755 MeV
+The mass of the muon in its rest frame, given as 105.6583755 MeV.
 
 This value is taken from the PDG 2020 recommended values of the fundamental physical constants.
 

src/cross_section.jl

@@ -45,7 +45,7 @@ julia> differential_cross_section(E_in, cos_theta)
 function differential_cross_section(E_in, cos_theta)
     T = typeof(E_in)
 
-    # enfore the irrational constants to be the same type as E_in
+    # enforce the irrational constants to be the same type as E_in
     alpha = convert(T,ALPHA)
     me = convert(T,ELECTRON_MASS)
     mmu = convert(T,MUON_MASS)
@@ -93,7 +93,7 @@ julia> total_cross_section(E_in)
 function total_cross_section(E_in)
     T = typeof(E_in)
 
-    # enfore the irrational constants to be the same type as E_in
+    # enforce the irrational constants to be the same type as E_in
     alpha = convert(T,ALPHA)
     me = convert(T,ELECTRON_MASS)
     mmu = convert(T,MUON_MASS)

src/event_generation/serial.jl

@@ -1,7 +1,7 @@
 """
     max_weight(E_in)
 
-Return the maximum weight, i.e. the maxmaximum value of [`differential_cross_section`](@ref) for specified initial electron energy `E_in. 
+Return the maximum weight, i.e. the maximum value of [`differential_cross_section`](@ref) for specified initial electron energy `E_in`. 
 
 # Example
 ```jldoctest
@@ -38,17 +38,17 @@ flat random distribution in the cosine of the scattering angle and azimuthal ang
 julia> rng = MersenneTwister(137)
 julia> event_list = generate_flat_events_cpu(rng, 1e3, 1000);
 ```
-The `;` should be used at the end of the last promt to suppress printing the whole event list.
+The `;` should be used at the end of the last prompt to suppress printing the whole event list.
 
 # Notes
 - This method generates weighted events where the weights are derived from the differential cross section. For unweighted events, use [`generate_events_cpu`](@ref).
 """
 function generate_flat_events_cpu(rng::AbstractRNG,E_in::T,nevents::Int) where {T<:Real}
     cth_arr = 2 .* rand(rng,nevents) .- 1
     phi_arr = (2*pi) .* rand(rng,nevents) 
-    weigth_list = differential_cross_section.(E_in,cth_arr)
+    weight_list = differential_cross_section.(E_in,cth_arr)
 
-    event_list = Event.(E_in,cth_arr,phi_arr,weigth_list)
+    event_list = Event.(E_in,cth_arr,phi_arr,weight_list)
 
     return event_list
 end

src/event_generation/threadsafe.jl

@@ -14,7 +14,7 @@ differential cross-section for the process.
 """
 function generate_flat_event(E_in::T) where {T<:Real}
     cth = 2 * rand(T) - 1
-    phi = rand(T) 
+    phi = 2 * pi * rand(T) 
     weight = differential_cross_section(E_in,cth)
 
     event= Event(E_in,cth,phi,weight)

src/events.jl

@@ -50,7 +50,7 @@ Event e-e+ -> mu-mu+
 
 	muon:      (9.5, 2.0, 1.0, 8.0)
 
-	anti muon: (10.5, -2.0, -1.0, -8.0)
+	anti-muon: (10.5, -2.0, -1.0, -8.0)
 
 	weight:    1.2
 ```
@@ -101,15 +101,15 @@ function Base.show(io::IO, m::MIME"text/plain", event::Event)
             \telectron:  $(event.electron_momentum)
             \tpositron:  $(event.positron_momentum)
             \tmuon:      $(event.muon_momentum)
-            \tanti muon: $(event.anti_muon_momentum)
+            \tanti-muon: $(event.anti_muon_momentum)
             \tweight:    $(event.weight)
             """)
     return nothing
 end
 
 ###
 # accessor functions
-# see FourMomentumBase.jl for a more exhaused list
+# see FourMomentumBase.jl for a more exhausted list
 ###
 
 function muon_cos_theta(event)

src/four_momentum.jl

@@ -127,7 +127,7 @@ Computes the Minkowski dot product of two four-momentum vectors. The dot product
 Minkowski metric `(+,-,-,-)`. For ``p_i = (E_i,p_i^x,p_i^y,p_i^z)`` with ``i=1,2``, the result is:
 
 ```math
-    p_1 \\cdot p_2 = E_1E_2 - p_1^xp_2^x - p_1^yp_2^y + p_1^zp_2^z
+    p_1 \\cdot p_2 = E_1E_2 - p_1^xp_2^x - p_1^yp_2^y - p_1^zp_2^z
 ```
 
 # Example
@@ -150,7 +150,7 @@ end
 function _construct_moms_from_coords(E_in, cos_theta, phi)
     T = typeof(E_in)
 
-    # enfore the irrational constants to be the same type as E_in
+    # enforce the irrational constants to be the same type as E_in
     me = convert(T,ELECTRON_MASS)
     mmu = convert(T,MUON_MASS)
 

test/four_momentum.jl

@@ -31,7 +31,7 @@ RNG = MersenneTwister(137)
         @test isapprox(p1_plus_p2.z,z1 + z2)
     end
 
-    @testset "substraction" begin
+    @testset "subtraction" begin
         p1_minus_p2 = @inferred p1 - p2
         @test isapprox(p1_minus_p2.en,en1 - en2)
         @test isapprox(p1_minus_p2.x,x1 - x2)