Skip to content

Commit

Permalink
Final touches to make new patch
Browse files Browse the repository at this point in the history
  • Loading branch information
cgrudz committed Nov 3, 2022
1 parent bd244dc commit 90e0c8a
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DataAssimilationBenchmarks"
uuid = "7c720533-a3c7-49b7-973c-85ef17efca74"
authors = ["Colin Grudzien <[email protected]> and contributors"]
version = "0.3.1"
version = "0.3.1.1"

[deps]
BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
Expand Down
10 changes: 6 additions & 4 deletions docs/src/submodules/analysis/ProcessExperimentData.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/src/submodules/experiments/ParallelExperimentDriver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
##############################################################################################
Expand Down
2 changes: 1 addition & 1 deletion src/DataAssimilationBenchmarks.jl
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ function Info()

print("\n")
printstyled(" Welcome to DataAssimilationBenchmarks!\n", bold=true)
print(" Version v0.3.1, Copyright 2022 Colin Grudzien ([email protected]) et al.\n")
print(" Version v0.3.1.1, Copyright 2022 Colin Grudzien ([email protected]) 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")
Expand Down

0 comments on commit 90e0c8a

Please sign in to comment.