add progress bar, fix startup config, release v0.1.1

Project.toml

@@ -1,15 +1,17 @@
 name = "ParameterSpace"
 uuid = "1cbe449d-ba56-45e5-b823-2aefb7650dd9"
 authors = ["islent <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 IterTools = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 DataFrames = "1"
 IterTools = "1"
+ProgressMeter = "1"
 julia = "1.6.0"

src/ParameterSpace.jl

@@ -1,12 +1,12 @@
 module ParameterSpace
 
 using IterTools, DataFrames, Printf
+using ProgressMeter
 
 import Base: iterate, length
 
 export
     Parameter,
-
     write_parameter_file,
     analyse_function, analyse_program
 
@@ -34,7 +34,7 @@ end
 ########## Analyse Functions ##########
 
 """
-    function analyse_function(f::Function, Params::Array{Parameter,1}, arg...;)
+    function analyse_function(f::Function, Params::Array{Parameter,1}, arg...; kw...)
 
 Tuning the function `f` over some of its arguments defined in `Params`. The outputs of `f` are stored in a `DataFrame`.
 
@@ -52,7 +52,7 @@ params = [Parameter("y", 2, 0:0.1:0.5)]
 result = analyse_function(g, params, 1.0)
 ```
 """
-function analyse_function(f::Function, Params::Array{Parameter,1}, arg...;)
+function analyse_function(f::Function, Params, arg...; kw...)
     # Construct parameter space
     Space = Iterators.product([p.Range for p in Params]...)
 
@@ -73,12 +73,12 @@ function analyse_function(f::Function, Params::Array{Parameter,1}, arg...;)
         tuning[!, Symbol(p.Name)] = Any[]
     end
     tuning[!, :result] = Any[]
-    for s in Space
+    @showprogress for s in Space
         # Prepare for the argument list
         for i in 1:length(Params)
             args[Params[i].Index] = s[i]
         end
-        push!(tuning, (s..., f(args...)))
+        push!(tuning, (s..., f(args...; kw...)))
     end
 
     return tuning
@@ -151,7 +151,7 @@ end
 result = analyse_program(command, content, "param.txt", params, analyse, args = [-15])
 ```
 """
-function analyse_program(command::Cmd, content::String, filename::String, Params::Array{Parameter,1}, analyse::Function = emptyfunction; args = [], OutputDir = "output")
+function analyse_program(command::Cmd, content::String, filename::String, Params, analyse::Function = emptyfunction; args = [], OutputDir = "output")
     # Construct parameter space
     Space = Iterators.product([p.Range for p in Params]...)
 
@@ -164,7 +164,7 @@ function analyse_program(command::Cmd, content::String, filename::String, Params
     end
     tuning[!,:result] = Any[]
 
-    for s in Space
+    @showprogress for s in Space
         folder = join(map(string, s), ", ")
         mkdir(folder)
         cd(folder)

test/runtests.jl

@@ -18,13 +18,14 @@ end
 
 @testset "Tuning program" begin
     script = joinpath(pwd(), "program.jl")
-    command = `julia $script`
+    command = `julia --startup-file=no $script`
 
     params = [Parameter("x", 1, [1,10,100]),
               Parameter("y", 2, [1000,10000])]
 
     content = "x = %d, y = %d"
 
+    # param.txt is writen before running the program, we simply read the file
     function analyse(x::Int)
         f = readlines("param.txt")
         return length(f[1]) + x