format SciML Style

Author: ChrisRackauckas

.JuliaFormatter.toml

@@ -0,0 +1 @@
+style = "sciml"

.github/workflows/FormatCheck.yml

@@ -0,0 +1,42 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@v1
+      - name: Install JuliaFormatter and format
+        # This will use the latest version by default but you can set the version like so:
+        #
+        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
+        run: |
+          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end'

docs/make.jl

@@ -2,18 +2,14 @@ using Documenter, ParameterizedFunctions
 
 include("pages.jl")
 
-makedocs(
-    sitename="ParameterizedFunctions.jl",
-    authors="Chris Rackauckas",
-    modules=[ParameterizedFunctions],
-    clean=true,doctest=false,
-    format = Documenter.HTML(analytics = "UA-90474609-3",
-                             assets = ["assets/favicon.ico"],
-                             canonical="https://parameterizedfunctions.sciml.ai/stable/"),
-    pages=pages
-)
+makedocs(sitename = "ParameterizedFunctions.jl",
+         authors = "Chris Rackauckas",
+         modules = [ParameterizedFunctions],
+         clean = true, doctest = false,
+         format = Documenter.HTML(analytics = "UA-90474609-3",
+                                  assets = ["assets/favicon.ico"],
+                                  canonical = "https://parameterizedfunctions.sciml.ai/stable/"),
+         pages = pages)
 
-deploydocs(
-   repo = "github.com/SciML/ParameterizedFunctions.jl.git";
-   push_preview = true
-)
+deploydocs(repo = "github.com/SciML/ParameterizedFunctions.jl.git";
+           push_preview = true)

docs/pages.jl

@@ -1,6 +1,6 @@
 # Put in a separate page so it can be used by SciMLDocs.jl
 
-pages=[
+pages = [
     "Home" => "index.md",
     "ode_def.md",
-]
+]

src/ParameterizedFunctions.jl

@@ -6,29 +6,25 @@ $(DocStringExtensions.README)
 module ParameterizedFunctions
 
 using DocStringExtensions
-  using DataStructures, DiffEqBase, Latexify
-  using Reexport
-  @reexport using ModelingToolkit
-  using ModelingToolkit: Sym, FnType, tosymbol
+using DataStructures, DiffEqBase, Latexify
+using Reexport
+@reexport using ModelingToolkit
+using ModelingToolkit: Sym, FnType, tosymbol
 
+import LinearAlgebra
 
-  import LinearAlgebra
+import Base: getindex
 
-  import Base: getindex
+include("ode_def_opts.jl")
+include("ode_findrep.jl")
+include("utils.jl")
+include("dict_build.jl")
+include("macros.jl")
+include("latexify.jl")
 
-  include("ode_def_opts.jl")
-  include("ode_findrep.jl")
-  include("utils.jl")
-  include("dict_build.jl")
-  include("macros.jl")
-  include("latexify.jl")
-
-  export @ode_def,ode_def_opts,@ode_def_bare, @ode_def_all
+export @ode_def, ode_def_opts, @ode_def_bare, @ode_def_all
 end # module
 
-
-
-
 ##### Extra
 
 # Jacobian Factorization

src/dict_build.jl

@@ -1,34 +1,34 @@
-function build_indvar_dict(ex,depvar)
-  indvar_dict = OrderedDict{Symbol,Int}()
-  cur_sym = 0
-  for i in 2:2:length(ex.args) #Every odd line is line number
-    arg = ex.args[i].args[1] #Get the first thing, should be dsomething
-    firstarg = Symbol(first(string(arg))) # Check for d
-    if firstarg == :d
-      nodarg = Symbol(join(Base.Iterators.drop(string(arg), 1)))
-      if nodarg == depvar
-        warn("$depvar is fixed as the independent variable but is also used as a dependent variable. Results my be incorrect.")
-      end
-      if !haskey(indvar_dict,nodarg)
-        cur_sym += 1
-        indvar_dict[nodarg] = cur_sym
-      else
-        error("The derivative term for $nodarg is repeated. This is not allowed.")
-      end
+function build_indvar_dict(ex, depvar)
+    indvar_dict = OrderedDict{Symbol, Int}()
+    cur_sym = 0
+    for i in 2:2:length(ex.args) #Every odd line is line number
+        arg = ex.args[i].args[1] #Get the first thing, should be dsomething
+        firstarg = Symbol(first(string(arg))) # Check for d
+        if firstarg == :d
+            nodarg = Symbol(join(Base.Iterators.drop(string(arg), 1)))
+            if nodarg == depvar
+                warn("$depvar is fixed as the independent variable but is also used as a dependent variable. Results my be incorrect.")
+            end
+            if !haskey(indvar_dict, nodarg)
+                cur_sym += 1
+                indvar_dict[nodarg] = cur_sym
+            else
+                error("The derivative term for $nodarg is repeated. This is not allowed.")
+            end
+        end
     end
-  end
-  syms = indvar_dict.keys
-  indvar_dict,syms
+    syms = indvar_dict.keys
+    indvar_dict, syms
 end
 
 function build_param_list(params)
-  param_list = Vector{Symbol}();
-  for i in 1:length(params)
-    if typeof(params[i]) <: Symbol
-      push!(param_list,params[i])
-    elseif params[i].head == :call || params[i].head == :(=)
-      warn("p=>val and p=val are deprecated. Simply list the parameters. See the DifferentialEquations.jl documentation for more information on the syntax change.")
+    param_list = Vector{Symbol}()
+    for i in 1:length(params)
+        if typeof(params[i]) <: Symbol
+            push!(param_list, params[i])
+        elseif params[i].head == :call || params[i].head == :(=)
+            warn("p=>val and p=val are deprecated. Simply list the parameters. See the DifferentialEquations.jl documentation for more information on the syntax change.")
+        end
     end
-  end
-  param_dict
+    param_dict
 end

src/latexify.jl

@@ -1,3 +1,3 @@
-@latexrecipe function f(func::DiffEqBase.AbstractParameterizedFunction)
-    return latexify(func.sys)
-end
+@latexrecipe function f(func::DiffEqBase.AbstractParameterizedFunction)
+    return latexify(func.sys)
+end

src/macros.jl

@@ -32,18 +32,17 @@ end a b c d
 extra definitions (Jacobian, parameter Jacobian, etc.) defined through the MTK
 symbolic tools.
 """
-macro ode_def(name,ex,params...)
-    opts = Dict{Symbol,Bool}(
-    :build_tgrad => true,
-    :build_jac => true,
-    :build_expjac => false,
-    :build_invjac => false,
-    :build_invW => false,
-    :build_hes => false,
-    :build_invhes => false,
-    :build_dpfuncs => true)
-    name isa Expr ? ode_def_opts(gensym(),opts,__module__,name,ex,params...) :
-        ode_def_opts(name,opts,__module__,ex,params...)
+macro ode_def(name, ex, params...)
+    opts = Dict{Symbol, Bool}(:build_tgrad => true,
+                              :build_jac => true,
+                              :build_expjac => false,
+                              :build_invjac => false,
+                              :build_invW => false,
+                              :build_hes => false,
+                              :build_invhes => false,
+                              :build_dpfuncs => true)
+    name isa Expr ? ode_def_opts(gensym(), opts, __module__, name, ex, params...) :
+    ode_def_opts(name, opts, __module__, ex, params...)
 end
 
 """
@@ -56,18 +55,17 @@ end parameters :: ODEFunction
 Like `@ode_def` but the `opts` options are set so that no symbolic functions are generated.
 See the `@ode_def` docstring for more details.
 """
-macro ode_def_bare(name,ex,params...)
-    opts = Dict{Symbol,Bool}(
-    :build_tgrad => false,
-    :build_jac => false,
-    :build_expjac => false,
-    :build_invjac => false,
-    :build_invW => false,
-    :build_hes => false,
-    :build_invhes => false,
-    :build_dpfuncs => false)
-    name isa Expr ? ode_def_opts(gensym(),opts,__module__,name,ex,params...) :
-        ode_def_opts(name,opts,__module__,ex,params...)
+macro ode_def_bare(name, ex, params...)
+    opts = Dict{Symbol, Bool}(:build_tgrad => false,
+                              :build_jac => false,
+                              :build_expjac => false,
+                              :build_invjac => false,
+                              :build_invW => false,
+                              :build_hes => false,
+                              :build_invhes => false,
+                              :build_dpfuncs => false)
+    name isa Expr ? ode_def_opts(gensym(), opts, __module__, name, ex, params...) :
+    ode_def_opts(name, opts, __module__, ex, params...)
 end
 
 """
@@ -80,16 +78,15 @@ end parameters :: ODEFunction
 Like `@ode_def` but the `opts` options are set so that all possible symbolic functions are generated.
 See the `@ode_def` docstring for more details.
 """
-macro ode_def_all(name,ex,params...)
-    opts = Dict{Symbol,Bool}(
-    :build_tgrad => true,
-    :build_jac => true,
-    :build_expjac => false,
-    :build_invjac => false,
-    :build_invW => true,
-    :build_hes => false,
-    :build_invhes => false,
-    :build_dpfuncs => true)
-    name isa Expr ? ode_def_opts(gensym(),opts,__module__,name,ex,params...) :
-        ode_def_opts(name,opts,__module__,ex,params...)
+macro ode_def_all(name, ex, params...)
+    opts = Dict{Symbol, Bool}(:build_tgrad => true,
+                              :build_jac => true,
+                              :build_expjac => false,
+                              :build_invjac => false,
+                              :build_invW => true,
+                              :build_hes => false,
+                              :build_invhes => false,
+                              :build_dpfuncs => true)
+    name isa Expr ? ode_def_opts(gensym(), opts, __module__, name, ex, params...) :
+    ode_def_opts(name, opts, __module__, ex, params...)
 end