Rename package to DynamicQuantities.jl

Author: MilesCranmer

.github/workflows/CI.yml

@@ -60,6 +60,6 @@ jobs:
       - run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest
-            using DynamicUnits
-            DocMeta.setdocmeta!(DynamicUnits, :DocTestSetup, :(using DynamicUnits); recursive=true)
-            doctest(DynamicUnits)'
+            using DynamicQuantities
+            DocMeta.setdocmeta!(DynamicQuantities, :DocTestSetup, :(using DynamicQuantities); recursive=true)
+            doctest(DynamicQuantities)'

Project.toml

@@ -1,4 +1,4 @@
-name = "DynamicUnits"
+name = "DynamicQuantities"
 uuid = "06fc5a27-2a28-4c7c-a15d-362465fb6821"
 authors = ["MilesCranmer <[email protected]> and contributors"]
 version = "0.1.0"
@@ -11,7 +11,7 @@ Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [extensions]
-DynamicUnitsUnitfulExt = "Unitful"
+DynamicQuantitiesUnitfulExt = "Unitful"
 
 [compat]
 Ratios = "0.4"

README.md

@@ -1,21 +1,21 @@
-# DynamicUnits
+# DynamicQuantities
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://symbolicml.org/DynamicUnits.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://symbolicml.org/DynamicUnits.jl/dev/)
-[![Build Status](https://github.com/SymbolicML/DynamicUnits.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SymbolicML/DynamicUnits.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://coveralls.io/repos/github/SymbolicML/DynamicUnits.jl/badge.svg?branch=main)](https://coveralls.io/github/SymbolicML/DynamicUnits.jl?branch=main)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://symbolicml.org/DynamicQuantities.jl/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://symbolicml.org/DynamicQuantities.jl/dev/)
+[![Build Status](https://github.com/SymbolicML/DynamicQuantities.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SymbolicML/DynamicQuantities.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Coverage](https://coveralls.io/repos/github/SymbolicML/DynamicQuantities.jl/badge.svg?branch=main)](https://coveralls.io/github/SymbolicML/DynamicQuantities.jl?branch=main)
 
 This defines a simple statically-typed `Quantity` type for Julia.
 Physical dimensions are stored as a *value*, as opposed to a parametric type, as in [Unitful.jl](https://github.com/PainterQubits/Unitful.jl).
 This is done to allow for calculations where physical dimensions are not known at compile time.
 
 ## Performance
 
-DynamicUnits can greatly outperform Unitful
+DynamicQuantities can greatly outperform Unitful
 when the compiler cannot infer dimensions in a function:
 
 ```julia
-julia> using BenchmarkTools, DynamicUnits; import Unitful
+julia> using BenchmarkTools, DynamicQuantities; import Unitful
 
 julia> dyn_uni = Quantity(0.2, mass=1, length=0.5, amount=3)
 0.2 𝐋 ¹ᐟ² 𝐌 ¹ 𝐍 ³
@@ -33,7 +33,7 @@ julia> @btime f($unitful, i) setup=(i=rand(1:10));
 ```
 
 **(Note the μ and n.)**
-Here, the DynamicUnits quantity object allows the compiler to build a function that is type stable,
+Here, the DynamicQuantities quantity object allows the compiler to build a function that is type stable,
 while the Unitful quantity object, which stores its dimensions in the type, requires type inference at runtime.
 
 However, if the dimensions in your function *can* be inferred by the compiler,
@@ -128,16 +128,16 @@ julia> ustrip(x)
 
 ## Units
 
-Despite the name, DynamicUnits does not actually work with units. Instead, it works with *dimensions*.
-You can use Unitful to parse units, and use the DynamicUnits->Unitful extension for conversion:
+Despite the name, DynamicQuantities does not actually work with units. Instead, it works with *dimensions*.
+You can use Unitful to parse units, and use the DynamicQuantities->Unitful extension for conversion:
 
 ```julia
 julia> using Unitful: Unitful, @u_str
 
 julia> x = 0.5u"km/s"
 0.5 km s⁻¹
 
-julia> y = convert(DynamicUnits.Quantity, x)
+julia> y = convert(DynamicQuantities.Quantity, x)
 500.0 𝐋 ¹ 𝐓 ⁻¹
 
 julia> y2 = y^2 * 0.3

benchmark/benchmarks.jl

@@ -1,5 +1,5 @@
 using BenchmarkTools
-using DynamicUnits
+using DynamicQuantities
 
 const SUITE = BenchmarkGroup()
 

docs/Project.toml

@@ -1,3 +1,3 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-DynamicUnits = "06fc5a27-2a28-4c7c-a15d-362465fb6821"
+DynamicQuantities = "06fc5a27-2a28-4c7c-a15d-362465fb6821"

docs/make.jl

@@ -1,7 +1,7 @@
-using DynamicUnits
+using DynamicQuantities
 using Documenter
 
-DocMeta.setdocmeta!(DynamicUnits, :DocTestSetup, :(using DynamicUnits); recursive=true)
+DocMeta.setdocmeta!(DynamicQuantities, :DocTestSetup, :(using DynamicQuantities); recursive=true)
 
 readme = open(dirname(@__FILE__) * "/../README.md") do io
     read(io, String)
@@ -26,13 +26,13 @@ open(dirname(@__FILE__) * "/src/index.md", "w") do io
 end
 
 makedocs(;
-    modules=[DynamicUnits],
+    modules=[DynamicQuantities],
     authors="MilesCranmer <[email protected]> and contributors",
-    repo="https://github.com/SymbolicML/DynamicUnits.jl/blob/{commit}{path}#{line}",
-    sitename="DynamicUnits.jl",
+    repo="https://github.com/SymbolicML/DynamicQuantities.jl/blob/{commit}{path}#{line}",
+    sitename="DynamicQuantities.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://symbolicml.org/DynamicUnits.jl",
+        canonical="https://symbolicml.org/DynamicQuantities.jl",
         edit_link="main",
         assets=String[]
     ),
@@ -43,6 +43,6 @@ makedocs(;
 )
 
 deploydocs(;
-    repo="github.com/SymbolicML/DynamicUnits.jl",
+    repo="github.com/SymbolicML/DynamicQuantities.jl",
     devbranch="main"
 )

docs/src/api.md

@@ -1,15 +1,15 @@
 ```@meta
-CurrentModule = DynamicUnits
+CurrentModule = DynamicQuantities
 ```
 
 # API Reference
 
-API Reference for [DynamicUnits](https://github.com/SymbolicML/DynamicUnits.jl).
+API Reference for [DynamicQuantities](https://github.com/SymbolicML/DynamicQuantities.jl).
 
 ```@index
 ```
 
 ```@autodocs
-Modules = [DynamicUnits]
+Modules = [DynamicQuantities]
 Order   = [:type, :function]
 ```

ext/DynamicUnitsUnitfulExt.jl renamed to ext/DynamicQuantitiesUnitfulExt.jl

@@ -1,11 +1,11 @@
-module DynamicUnitsUnitfulExt
+module DynamicQuantitiesUnitfulExt
 
 if isdefined(Base, :get_extension)
-    import DynamicUnits
+    import DynamicQuantities
     import Unitful
     import Unitful: @u_str
 else
-    import ..DynamicUnits
+    import ..DynamicQuantities
     import ..Unitful
     import ..Unitful: @u_str
 end
@@ -15,10 +15,10 @@ const UNITFUL_EQUIVALENCIES = let basic = (length=u"m", mass=u"kg", time=u"s", c
     NamedTuple((k => Unitful.upreferred(basic[k]) for k in keys(basic)))
 end
 
-Base.convert(::Type{Unitful.Quantity}, x::DynamicUnits.Quantity) =
+Base.convert(::Type{Unitful.Quantity}, x::DynamicQuantities.Quantity) =
     let
-        cumulator = DynamicUnits.ustrip(x)
-        dims = DynamicUnits.dimension(x)
+        cumulator = DynamicQuantities.ustrip(x)
+        dims = DynamicQuantities.dimension(x)
         for dim in keys(dims)
             value = dims[dim]
             iszero(value) && continue
@@ -27,20 +27,20 @@ Base.convert(::Type{Unitful.Quantity}, x::DynamicUnits.Quantity) =
         cumulator
     end
 
-Base.convert(::Type{DynamicUnits.Quantity}, x::Unitful.Quantity) =
+Base.convert(::Type{DynamicQuantities.Quantity}, x::Unitful.Quantity) =
     let
         value = Unitful.ustrip(Unitful.upreferred(x))
-        dimension = convert(DynamicUnits.Dimensions, Unitful.dimension(x))
-        return DynamicUnits.Quantity(value, dimension)
+        dimension = convert(DynamicQuantities.Dimensions, Unitful.dimension(x))
+        return DynamicQuantities.Quantity(value, dimension)
     end
 
-Base.convert(::Type{DynamicUnits.Dimensions}, d::Unitful.Dimensions{D}) where {D} =
+Base.convert(::Type{DynamicQuantities.Dimensions}, d::Unitful.Dimensions{D}) where {D} =
     let
-        cumulator = DynamicUnits.Dimensions()
+        cumulator = DynamicQuantities.Dimensions()
         for dim in D
             dim_symbol = _map_dim_name_to_dynamic_units(typeof(dim))
             dim_power = dim.power
-            cumulator *= DynamicUnits.Dimensions(; dim_symbol => dim_power)
+            cumulator *= DynamicQuantities.Dimensions(; dim_symbol => dim_power)
         end
         cumulator
     end

src/DynamicUnits.jl renamed to src/DynamicQuantities.jl

@@ -1,4 +1,4 @@
-module DynamicUnits
+module DynamicQuantities
 
 export Quantity, Dimensions, ustrip, dimension, valid
 export ulength, umass, utime, ucurrent, utemperature, uluminosity, uamount
@@ -12,7 +12,7 @@ include("math.jl")
 import Requires: @init, @require
 
 if !isdefined(Base, :get_extension)
-    @init @require Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d" include("../ext/DynamicUnitsUnitfulExt.jl")
+    @init @require Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d" include("../ext/DynamicQuantitiesUnitfulExt.jl")
 end
 
 end

test/unitful.jl

@@ -1,10 +1,10 @@
-import DynamicUnits
+import DynamicQuantities
 import Unitful
 import Unitful: @u_str
 using Test
 
-x = DynamicUnits.Quantity(0.2, amount=2, current=-1 // 2, luminosity=2 // 5)
+x = DynamicQuantities.Quantity(0.2, amount=2, current=-1 // 2, luminosity=2 // 5)
 x_unitful = 0.2u"mol^2*A^(-1//2)*cd^(2//5)"
 
 @test convert(Unitful.Quantity, x) ≈ x_unitful
-@test convert(DynamicUnits.Quantity, convert(Unitful.Quantity, x)) ≈ x
+@test convert(DynamicQuantities.Quantity, convert(Unitful.Quantity, x)) ≈ x

test/unittests.jl

@@ -1,4 +1,4 @@
-using DynamicUnits
+using DynamicQuantities
 using Test
 
 @testset "Basic utilities" begin