diff --git a/Project.toml b/Project.toml index 6483638a..725a02e7 100755 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "DataAssimilationBenchmarks" uuid = "7c720533-a3c7-49b7-973c-85ef17efca74" authors = ["Colin Grudzien and contributors"] -version = "0.3.1" +version = "0.3.1.1" [deps] BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf" diff --git a/docs/src/submodules/analysis/ProcessExperimentData.md b/docs/src/submodules/analysis/ProcessExperimentData.md index 98c5431c..394c25db 100755 --- a/docs/src/submodules/analysis/ProcessExperimentData.md +++ b/docs/src/submodules/analysis/ProcessExperimentData.md @@ -2,10 +2,12 @@ ## Processing experiment outputs -The `analysis` directory contains scripts for batch processing the outputs from experiments into time-averaged -RMSE and spread and arranging these outputs in an array for plotting. This should be modified based on the -local paths to stored data. This will try to load files based on parameter settings written in the name of -the output .jld2 file and if this is not available, this will store `Inf` values in the place of missing data. +The `analysis` directory contains examples for batch processing the outputs from experiments into time-averaged +RMSE and spread and arranging these outputs in an array for plotting. These examples should be modified based +on the local paths to stored data and experiment settings. This will try to load files based on parameter settings +written in the name of the output `.jld2` file and if this is not available, this will store `Inf` values in the +place of missing data. These scripts are not currently integrated or supported, with the expecation that +one will write their own variants based on their needs with specific experiments. ## Validating results Benchmark configurations for the above filtering and smoothing experiments are available in the open access article diff --git a/docs/src/submodules/experiments/ParallelExperimentDriver.md b/docs/src/submodules/experiments/ParallelExperimentDriver.md index b930b822..83f70466 100755 --- a/docs/src/submodules/experiments/ParallelExperimentDriver.md +++ b/docs/src/submodules/experiments/ParallelExperimentDriver.md @@ -11,12 +11,12 @@ This module defines argumentless functions to construct an array with each array by a [NamedTuple](https://docs.julialang.org/en/v1/base/base/#Core.NamedTuple), defining a particular hyper-parameter configuration. These functions also define a soft-fail method for evaluating experiments, with example syntax as -``` +```{julia} args, wrap_exp = method() ``` where the `wrap_exp` follows a convention of -``` +```{julia} function wrap_exp(arguments) try exp(arguments) @@ -125,7 +125,7 @@ end With a constructor as above, one can define a script as follows to run the sensitivity test: -``` +```{julia} ############################################################################################## module run_sensitivity_test ############################################################################################## diff --git a/src/DataAssimilationBenchmarks.jl b/src/DataAssimilationBenchmarks.jl index 81d55710..a6b7b3e3 100755 --- a/src/DataAssimilationBenchmarks.jl +++ b/src/DataAssimilationBenchmarks.jl @@ -182,7 +182,7 @@ function Info() print("\n") printstyled(" Welcome to DataAssimilationBenchmarks!\n", bold=true) - print(" Version v0.3.1, Copyright 2022 Colin Grudzien (cgrudzien@ucsd.edu) et al.\n") + print(" Version v0.3.1.1, Copyright 2022 Colin Grudzien (cgrudzien@ucsd.edu) et al.\n") print(" Licensed under the Apache License, Version 2.0 \n") print(" https://github.com/cgrudz/DataAssimilationBenchmarks/blob/master/LICENSE.md\n") print("\n")