Make macro naming consistent

Author: HarrisonGrodin

README.md

@@ -28,9 +28,9 @@ and parameters. Therefore we label them as follows:
 using ModelingToolkit
 
 # Define some variables
-@param t σ ρ β
-@variable x(t) y(t) z(t)
-@deriv D'~t
+@parameters t σ ρ β
+@variables x(t) y(t) z(t)
+@derivatives D'~t
 ```
 
 Then we build the system:
@@ -81,8 +81,8 @@ state of the previous ODE. This is the nonlinear system defined by where the
 derivatives are zero. We use (unknown) variables for our nonlinear system.
 
 ```julia
-@variable x y z
-@param σ ρ β
+@variables x y z
+@parameters σ ρ β
 
 # Define a nonlinear system
 eqs = [0 ~ σ*(y-x),
@@ -243,9 +243,9 @@ is accessible via a function-based interface. This means that all macros are
 syntactic sugar in some form. For example, the variable construction:
 
 ```julia
-@param t σ ρ β
-@variable x(t) y(t) z(t)
-@deriv D'~t
+@parameters t σ ρ β
+@variables x(t) y(t) z(t)
+@derivatives D'~t
 ```
 
 is syntactic sugar for:
@@ -266,8 +266,8 @@ D = Differential(t)
 The system building functions can handle intermediate calculations. For example,
 
 ```julia
-@variable x y z
-@param σ ρ β
+@variables x y z
+@parameters σ ρ β
 a = y - x
 eqs = [0 ~ σ*a,
        0 ~ x*(ρ-z)-y,

src/differentials.jl

@@ -1,4 +1,4 @@
-export Differential, expand_derivatives, @deriv
+export Differential, expand_derivatives, @derivatives
 
 
 struct Differential <: Function
@@ -63,7 +63,7 @@ function _differential_macro(x)
     lhss = Symbol[]
     x = flatten_expr!(x)
     for di in x
-        @assert di isa Expr && di.args[1] == :~ "@deriv expects a form that looks like `@deriv D''~t E'~t`"
+        @assert di isa Expr && di.args[1] == :~ "@derivatives expects a form that looks like `@derivatives D''~t E'~t`"
         lhs = di.args[2]
         rhs = di.args[3]
         order, lhs = count_order(lhs)
@@ -75,7 +75,7 @@ function _differential_macro(x)
     ex
 end
 
-macro deriv(x...)
+macro derivatives(x...)
     esc(_differential_macro(x))
 end
 

src/variables.jl

@@ -1,4 +1,4 @@
-export Variable, @variable, @param
+export Variable, @variables, @parameters
 
 
 struct Variable <: Expression
@@ -70,9 +70,9 @@ function _parse_vars(macroname, known, x)
     push!(ex.args, build_expr(:tuple, var_names))
     return ex
 end
-macro variable(xs...)
+macro variables(xs...)
     esc(_parse_vars(:Variable, false, xs))
 end
-macro param(xs...)
+macro parameters(xs...)
     esc(_parse_vars(:Param, true, xs))
 end

test/derivatives.jl

@@ -2,9 +2,9 @@ using ModelingToolkit
 using Test
 
 # Derivatives
-@param t σ ρ β
-@variable x(t) y(t) z(t)
-@deriv D'~t D2''~t
+@parameters t σ ρ β
+@variables x(t) y(t) z(t)
+@derivatives D'~t D2''~t
 
 @test isequal(expand_derivatives(D(t)), 1)
 @test isequal(expand_derivatives(D(D(t))), 0)
@@ -47,7 +47,7 @@ jac = calculate_jacobian(sys)
 @test isequal(jac[3,3], -1*β)
 
 # Variable dependence checking in differentiation
-@variable a(t) b(a)
+@variables a(t) b(a)
 @test !isequal(D(b), 0)
 
 @test isequal(expand_derivatives(D(x * y)), simplify_constants(y*D(x) + x*D(y)))

test/simplify.jl

@@ -1,8 +1,8 @@
 using ModelingToolkit
 using Test
 
-@param t
-@variable x(t) y(t) z(t)
+@parameters t
+@variables x(t) y(t) z(t)
 
 null_op = 0*t
 @test isequal(simplify_constants(null_op), 0)

test/system_construction.jl

@@ -2,9 +2,9 @@ using ModelingToolkit
 using Test
 
 # Define some variables
-@param t σ ρ β
-@variable x(t) y(t) z(t)
-@deriv D'~t
+@parameters t σ ρ β
+@variables x(t) y(t) z(t)
+@derivatives D'~t
 
 # Define a differential equation
 eqs = [D(x) ~ σ*(y-x),
@@ -32,7 +32,7 @@ end
 test_vars_extraction(de, de2)
 
 @testset "time-varying parameters" begin
-    @param σ′(t)
+    @parameters σ′(t)
     eqs = [D(x) ~ σ′*(y-x),
            D(y) ~ x*(ρ-z)-y,
            D(z) ~ x*y - β*z]
@@ -46,9 +46,9 @@ test_vars_extraction(de, de2)
 end
 
 # Conversion to first-order ODEs #17
-@deriv D3'''~t
-@deriv D2''~t
-@variable u(t) u_tt(t) u_t(t) x_t(t)
+@derivatives D3'''~t
+@derivatives D2''~t
+@variables u(t) u_tt(t) u_t(t) x_t(t)
 eqs = [D3(u) ~ 2(D2(u)) + D(u) + D(x) + 1
        D2(x) ~ D(x) + 2]
 de = DiffEqSystem(eqs, t)
@@ -84,8 +84,8 @@ end
 
 generate_function(ns)
 
-@deriv D'~t
-@param A B C
+@derivatives D'~t
+@parameters A B C
 _x = y / C
 eqs = [D(x) ~ -A*x,
        D(y) ~ A*x - B*_x]
@@ -100,8 +100,8 @@ test_vars_extraction(de, DiffEqSystem(eqs))
 end
 
 # Now nonlinear system with only variables
-@variable x y z
-@param σ ρ β
+@variables x y z
+@parameters σ ρ β
 
 # Define a nonlinear system
 eqs = [0 ~ σ*(y-x),

test/variable_parsing.jl

@@ -1,10 +1,10 @@
 using ModelingToolkit
 using Test
 
-@param t
-@variable x(t)
-@variable y(t)
-@variable z(t)
+@parameters t
+@variables x(t)
+@variables y(t)
+@variables z(t)
 x1 = Variable(:x, [t])
 y1 = Variable(:y, [t])
 z1 = Variable(:z, [t])
@@ -15,7 +15,7 @@ z1 = Variable(:z, [t])
 @test convert(Expr, y) == :y
 @test convert(Expr, z) == :z
 
-@param begin
+@parameters begin
     t
     s
 end
@@ -27,7 +27,7 @@ s1 = Variable(:s; known = true)
 @test convert(Expr, s) == :s
 @test convert(Expr, cos(t + sin(s))) == :(cos(t + sin(s)))
 
-@deriv D'~t
+@derivatives D'~t
 D1 = Differential(t)
 @test D1 == D
 @test convert(Expr, D) == D