rename of package (#7)

mmikhasenko · web-flow · commit adf71893a310 · 2024-10-02T15:39:25.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# FourMomentumBase.jl
+# LorentzVectorBase.jl
 [WIP] Base interfaces for four-momenta in high-energy physics. 
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://szabo137.github.io/FourMomentumBase.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://szabo137.github.io/FourMomentumBase.jl/dev/)
-[![Build Status](https://github.com/szabo137/FourMomentumBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/szabo137/FourMomentumBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://szabo137.github.io/LorentzVectorBase.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://szabo137.github.io/LorentzVectorBase.jl/dev/)
+[![Build Status](https://github.com/szabo137/LorentzVectorBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/szabo137/LorentzVectorBase.jl/actions/workflows/CI.yml?query=branch%3Amain)
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,3 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-FourMomentumBase = "592a752d-6533-4762-a71b-738712ea30ec"
+LorentzVectorBase = "592a752d-6533-4762-a71b-738712ea30ec"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,20 +1,20 @@
-using FourMomentumBase
+using LorentzVectorBase
 using Documenter
 
 DocMeta.setdocmeta!(
-    FourMomentumBase, :DocTestSetup, :(using FourMomentumBase); recursive=true
+    LorentzVectorBase, :DocTestSetup, :(using LorentzVectorBase); recursive=true
 )
 
 makedocs(;
-    modules=[FourMomentumBase],
+    modules=[LorentzVectorBase],
     authors="Uwe Hernandez Acosta <u.hernandez@hzdr.de",
-    sitename="FourMomentumBase.jl",
+    sitename="LorentzVectorBase.jl",
     format=Documenter.HTML(;
-        canonical="https://szabo137.github.io/FourMomentumBase.jl",
+        canonical="https://szabo137.github.io/LorentzVectorBase.jl",
         edit_link="main",
         assets=String[],
     ),
     pages=["Home" => "index.md"],
 )
 
-deploydocs(; repo="github.com/szabo137/FourMomentumBase.jl", devbranch="main")
+deploydocs(; repo="github.com/szabo137/LorentzVectorBase.jl", devbranch="main")
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,14 +1,14 @@
 ```@meta
-CurrentModule = FourMomentumBase
+CurrentModule = LorentzVectorBase
 ```
 
-# FourMomentumBase
+# LorentzVectorBase
 
-Documentation for [FourMomentumBase](https://github.com/szabo137/FourMomentumBase.jl).
+Documentation for [LorentzVectorBase](https://github.com/szabo137/LorentzVectorBase.jl).
 
 ```@index
 ```
 
 ```@autodocs
-Modules = [FourMomentumBase]
+Modules = [LorentzVectorBase]
 ```
diff --git a/test/interface.jl b/test/interface.jl
@@ -1,27 +1,27 @@
-using FourMomentumBase
+using LorentzVectorBase
 
-struct TestCoordinteSystem <: FourMomentumBase.AbstractCoordinateSystem end
-FourMomentumBase.coordinate_names(::TestCoordinteSystem) = (:a, :b, :c, :d)
+struct TestCoordinteSystem <: LorentzVectorBase.AbstractCoordinateSystem end
+LorentzVectorBase.coordinate_names(::TestCoordinteSystem) = (:a, :b, :c, :d)
 
-for (fun_idx, fun) in enumerate(FourMomentumBase.FOURMOMENTUM_GETTER_FUNCTIONS)
+for (fun_idx, fun) in enumerate(LorentzVectorBase.FOURMOMENTUM_GETTER_FUNCTIONS)
     eval(
         quote
-            ($FourMomentumBase.$fun)(::$TestCoordinteSystem, mom) = $fun_idx
+            ($LorentzVectorBase.$fun)(::$TestCoordinteSystem, mom) = $fun_idx
         end,
     )
 end
 
 struct TestMomentum end
 
-FourMomentumBase.coordinate_system(::TestMomentum) = TestCoordinteSystem()
+LorentzVectorBase.coordinate_system(::TestMomentum) = TestCoordinteSystem()
 
 @testset "Accessor functions" begin
     mom = TestMomentum()
     @testset "$fun" for (i, fun) in
-                        enumerate(FourMomentumBase.FOURMOMENTUM_GETTER_FUNCTIONS)
+                        enumerate(LorentzVectorBase.FOURMOMENTUM_GETTER_FUNCTIONS)
         @test eval(
             quote
-                $FourMomentumBase.$fun
+                $LorentzVectorBase.$fun
             end,
         )(mom) == i
     end
@@ -30,15 +30,15 @@ end
 @testset "Aliasses" begin
     mom = TestMomentum()
     @testset "$alias, $fun" for (alias, fun) in
-                                FourMomentumBase.FOURMOMENTUM_GETTER_ALIASSES
+                                LorentzVectorBase.FOURMOMENTUM_GETTER_ALIASSES
         alias_result = eval(
             quote
-                $FourMomentumBase.$alias
+                $LorentzVectorBase.$alias
             end,
         )(mom)
         groundtruth = eval(
             quote
-                $FourMomentumBase.$fun
+                $LorentzVectorBase.$fun
             end,
         )(mom)
         @test alias_result == groundtruth
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,4 +1,4 @@
-using FourMomentumBase
+using LorentzVectorBase
 using Test
 using SafeTestsets
 
diff --git a/test/xyze.jl b/test/xyze.jl
@@ -1,6 +1,6 @@
 
 using Random
-using FourMomentumBase
+using LorentzVectorBase
 
 const ATOL = 1e-15
 const RNG = MersenneTwister(137137)
@@ -12,11 +12,11 @@ struct CustomMom
     z
 end
 
-FourMomentumBase.coordinate_system(::CustomMom) = FourMomentumBase.EXYZ()
-FourMomentumBase.px(mom::CustomMom) = mom.x
-FourMomentumBase.py(mom::CustomMom) = mom.y
-FourMomentumBase.pz(mom::CustomMom) = mom.z
-FourMomentumBase.energy(mom::CustomMom) = mom.e
+LorentzVectorBase.coordinate_system(::CustomMom) = LorentzVectorBase.EXYZ()
+LorentzVectorBase.px(mom::CustomMom) = mom.x
+LorentzVectorBase.py(mom::CustomMom) = mom.y
+LorentzVectorBase.pz(mom::CustomMom) = mom.z
+LorentzVectorBase.energy(mom::CustomMom) = mom.e
 
 x, y, z = rand(RNG, 3)
 m = rand(RNG)
@@ -26,114 +26,114 @@ mom_zero = CustomMom(0.0, 0.0, 0.0, 0.0)
 mom_offshell = CustomMom(0.0, 0.0, 0.0, m)
 
 @testset "spatial_magnitude consistence" for mom in [mom_onshell, mom_offshell, mom_zero]
-    @test FourMomentumBase.spatial_magnitude2(mom) == FourMomentumBase.mag2(mom)
-    @test FourMomentumBase.spatial_magnitude(mom) == FourMomentumBase.mag(mom)
-    @test isapprox(FourMomentumBase.spatial_magnitude(mom), sqrt(FourMomentumBase.spatial_magnitude2(mom)))
+    @test LorentzVectorBase.spatial_magnitude2(mom) == LorentzVectorBase.mag2(mom)
+    @test LorentzVectorBase.spatial_magnitude(mom) == LorentzVectorBase.mag(mom)
+    @test isapprox(LorentzVectorBase.spatial_magnitude(mom), sqrt(LorentzVectorBase.spatial_magnitude2(mom)))
 end
 
 @testset "spatial_magnitude values" begin
-    @test isapprox(FourMomentumBase.spatial_magnitude2(mom_onshell), x^2 + y^2 + z^2)
-    @test isapprox(FourMomentumBase.spatial_magnitude(mom_onshell), sqrt(x^2 + y^2 + z^2))
+    @test isapprox(LorentzVectorBase.spatial_magnitude2(mom_onshell), x^2 + y^2 + z^2)
+    @test isapprox(LorentzVectorBase.spatial_magnitude(mom_onshell), sqrt(x^2 + y^2 + z^2))
 end
 
 @testset "mass consistence" for mom_on in [mom_onshell, mom_zero]
-    @test FourMomentumBase.invariant_mass2(mom_on) == FourMomentumBase.mass2(mom_on)
-    @test FourMomentumBase.invariant_mass(mom_on) == FourMomentumBase.mass(mom_on)
+    @test LorentzVectorBase.invariant_mass2(mom_on) == LorentzVectorBase.mass2(mom_on)
+    @test LorentzVectorBase.invariant_mass(mom_on) == LorentzVectorBase.mass(mom_on)
     @test isapprox(
-        FourMomentumBase.invariant_mass(mom_on),
-        sqrt(FourMomentumBase.invariant_mass2(mom_on)),
+        LorentzVectorBase.invariant_mass(mom_on),
+        sqrt(LorentzVectorBase.invariant_mass2(mom_on)),
     )
 end
 
 @testset "mass value" begin
-    @test isapprox(FourMomentumBase.invariant_mass2(mom_onshell), E^2 - (x^2 + y^2 + z^2))
+    @test isapprox(LorentzVectorBase.invariant_mass2(mom_onshell), E^2 - (x^2 + y^2 + z^2))
     @test isapprox(
-        FourMomentumBase.invariant_mass(mom_onshell), sqrt(E^2 - (x^2 + y^2 + z^2))
+        LorentzVectorBase.invariant_mass(mom_onshell), sqrt(E^2 - (x^2 + y^2 + z^2))
     )
 
-    @test isapprox(FourMomentumBase.invariant_mass(mom_onshell), m)
-    @test isapprox(FourMomentumBase.invariant_mass(mom_offshell), -m)
-    @test isapprox(FourMomentumBase.invariant_mass(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.invariant_mass(mom_onshell), m)
+    @test isapprox(LorentzVectorBase.invariant_mass(mom_offshell), -m)
+    @test isapprox(LorentzVectorBase.invariant_mass(mom_zero), 0.0)
 end
 
 @testset "momentum components" begin
-    @test FourMomentumBase.energy(mom_onshell) == E
-    @test FourMomentumBase.px(mom_onshell) == x
-    @test FourMomentumBase.py(mom_onshell) == y
-    @test FourMomentumBase.pz(mom_onshell) == z
+    @test LorentzVectorBase.energy(mom_onshell) == E
+    @test LorentzVectorBase.px(mom_onshell) == x
+    @test LorentzVectorBase.py(mom_onshell) == y
+    @test LorentzVectorBase.pz(mom_onshell) == z
 
-    @test isapprox(FourMomentumBase.boost_beta(mom_onshell), sqrt(x^2 + y^2 + z^2) / E)
+    @test isapprox(LorentzVectorBase.boost_beta(mom_onshell), sqrt(x^2 + y^2 + z^2) / E)
     @test isapprox(
-        FourMomentumBase.boost_gamma(mom_onshell),
-        1 / sqrt(1.0 - FourMomentumBase.boost_beta(mom_onshell)^2),
+        LorentzVectorBase.boost_gamma(mom_onshell),
+        1 / sqrt(1.0 - LorentzVectorBase.boost_beta(mom_onshell)^2),
     )
 
-    @test FourMomentumBase.energy(mom_zero) == 0.0
-    @test FourMomentumBase.px(mom_zero) == 0.0
-    @test FourMomentumBase.py(mom_zero) == 0.0
-    @test FourMomentumBase.pz(mom_zero) == 0.0
+    @test LorentzVectorBase.energy(mom_zero) == 0.0
+    @test LorentzVectorBase.px(mom_zero) == 0.0
+    @test LorentzVectorBase.py(mom_zero) == 0.0
+    @test LorentzVectorBase.pz(mom_zero) == 0.0
 
-    @test isapprox(FourMomentumBase.boost_beta(mom_zero), 0.0)
-    @test isapprox(FourMomentumBase.boost_gamma(mom_zero), 1.0)
+    @test isapprox(LorentzVectorBase.boost_beta(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.boost_gamma(mom_zero), 1.0)
 end
 
 @testset "transverse coordinates" for mom_on in [mom_onshell, mom_zero]
-    @test FourMomentumBase.transverse_momentum2(mom_on) == FourMomentumBase.pt2(mom_on)
-    @test FourMomentumBase.transverse_momentum2(mom_on) == FourMomentumBase.perp2(mom_on)
-    @test FourMomentumBase.transverse_momentum(mom_on) == FourMomentumBase.pt(mom_on)
-    @test FourMomentumBase.transverse_momentum(mom_on) == FourMomentumBase.perp(mom_on)
+    @test LorentzVectorBase.transverse_momentum2(mom_on) == LorentzVectorBase.pt2(mom_on)
+    @test LorentzVectorBase.transverse_momentum2(mom_on) == LorentzVectorBase.perp2(mom_on)
+    @test LorentzVectorBase.transverse_momentum(mom_on) == LorentzVectorBase.pt(mom_on)
+    @test LorentzVectorBase.transverse_momentum(mom_on) == LorentzVectorBase.perp(mom_on)
 
     @test isapprox(
-        FourMomentumBase.transverse_momentum(mom_on),
-        sqrt(FourMomentumBase.transverse_momentum2(mom_on)),
+        LorentzVectorBase.transverse_momentum(mom_on),
+        sqrt(LorentzVectorBase.transverse_momentum2(mom_on)),
     )
 
-    @test FourMomentumBase.transverse_mass2(mom_on) == FourMomentumBase.mt2(mom_on)
-    @test FourMomentumBase.transverse_mass(mom_on) == FourMomentumBase.mt(mom_on)
+    @test LorentzVectorBase.transverse_mass2(mom_on) == LorentzVectorBase.mt2(mom_on)
+    @test LorentzVectorBase.transverse_mass(mom_on) == LorentzVectorBase.mt(mom_on)
 end
 
 @testset "transverse coordiantes value" begin
-    @test isapprox(FourMomentumBase.transverse_momentum2(mom_onshell), x^2 + y^2)
-    @test isapprox(FourMomentumBase.transverse_momentum(mom_onshell), sqrt(x^2 + y^2))
-    @test isapprox(FourMomentumBase.transverse_mass2(mom_onshell), E^2 - z^2)
-    @test isapprox(FourMomentumBase.transverse_mass(mom_onshell), sqrt(E^2 - z^2))
-    @test isapprox(FourMomentumBase.transverse_mass(mom_offshell), -m)
-
-    @test isapprox(FourMomentumBase.rapidity(mom_onshell), 0.5 * log((E + z) / (E - z)))
-
-    @test isapprox(FourMomentumBase.transverse_momentum2(mom_zero), 0.0)
-    @test isapprox(FourMomentumBase.transverse_momentum(mom_zero), 0.0)
-    @test isapprox(FourMomentumBase.transverse_mass2(mom_zero), 0.0)
-    @test isapprox(FourMomentumBase.transverse_mass(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.transverse_momentum2(mom_onshell), x^2 + y^2)
+    @test isapprox(LorentzVectorBase.transverse_momentum(mom_onshell), sqrt(x^2 + y^2))
+    @test isapprox(LorentzVectorBase.transverse_mass2(mom_onshell), E^2 - z^2)
+    @test isapprox(LorentzVectorBase.transverse_mass(mom_onshell), sqrt(E^2 - z^2))
+    @test isapprox(LorentzVectorBase.transverse_mass(mom_offshell), -m)
+
+    @test isapprox(LorentzVectorBase.rapidity(mom_onshell), 0.5 * log((E + z) / (E - z)))
+
+    @test isapprox(LorentzVectorBase.transverse_momentum2(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.transverse_momentum(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.transverse_mass2(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.transverse_mass(mom_zero), 0.0)
 end
 
 @testset "spherical coordiantes consistence" for mom_on in [mom_onshell, mom_zero]
     @test isapprox(
-        FourMomentumBase.cos_theta(mom_on), cos(FourMomentumBase.polar_angle(mom_on))
+        LorentzVectorBase.cos_theta(mom_on), cos(LorentzVectorBase.polar_angle(mom_on))
     )
     @test isapprox(
-        FourMomentumBase.cos_phi(mom_on), cos(FourMomentumBase.azimuthal_angle(mom_on))
+        LorentzVectorBase.cos_phi(mom_on), cos(LorentzVectorBase.azimuthal_angle(mom_on))
     )
     @test isapprox(
-        FourMomentumBase.sin_phi(mom_on), sin(FourMomentumBase.azimuthal_angle(mom_on))
+        LorentzVectorBase.sin_phi(mom_on), sin(LorentzVectorBase.azimuthal_angle(mom_on))
     )
 end
 
 @testset "spherical coordiantes values" begin
     @test isapprox(
-        FourMomentumBase.polar_angle(mom_onshell),
-        atan(FourMomentumBase.transverse_momentum(mom_onshell), z),
+        LorentzVectorBase.polar_angle(mom_onshell),
+        atan(LorentzVectorBase.transverse_momentum(mom_onshell), z),
     )
-    @test isapprox(FourMomentumBase.polar_angle(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.polar_angle(mom_zero), 0.0)
 
-    @test isapprox(FourMomentumBase.azimuthal_angle(mom_onshell), atan(y, x))
-    @test isapprox(FourMomentumBase.azimuthal_angle(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.azimuthal_angle(mom_onshell), atan(y, x))
+    @test isapprox(LorentzVectorBase.azimuthal_angle(mom_zero), 0.0)
 end
 
 @testset "light-cone coordiantes" begin
-    @test isapprox(FourMomentumBase.plus_component(mom_onshell), 0.5 * (E + z))
-    @test isapprox(FourMomentumBase.minus_component(mom_onshell), 0.5 * (E - z))
+    @test isapprox(LorentzVectorBase.plus_component(mom_onshell), 0.5 * (E + z))
+    @test isapprox(LorentzVectorBase.minus_component(mom_onshell), 0.5 * (E - z))
 
-    @test isapprox(FourMomentumBase.plus_component(mom_zero), 0.0)
-    @test isapprox(FourMomentumBase.minus_component(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.plus_component(mom_zero), 0.0)
+    @test isapprox(LorentzVectorBase.minus_component(mom_zero), 0.0)
 end

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using FourMomentumBase`
	`1`	`+using LorentzVectorBase`
`2`	`2`	`using Test`
`3`	`3`	`using SafeTestsets`
`4`	`4`