Add run_reps.jl helper to run RME #26
+142
−3
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,134 @@ | ||||||
| using Dates | ||||||
| using Random | ||||||
|
|
||||||
| """ | ||||||
| run_rme(rme_path::String, n_threads::Int64, reps::Int64, result_path::String; start_year::Int64=2022, end_year::Int64=2099, batch_size::Int64=10, start_batch::Int64=1, RCP_scen::String="SSP 2.45", gcm::String="CNRM_ESM2_1", rnd_seed::Int64=1234)::Nothing | ||||||
|
|
||||||
| Run counterfactual scenarios with ReefModEngine.jl and save result set to desired directory. | ||||||
|
|
||||||
| # Arguments | ||||||
| - `rme_path` : Path to REM folder. | ||||||
| - `n_threads` : Number of threads to be used with RME. | ||||||
| - `reps` : Total number of repetitions to be run. | ||||||
| - `result_path` : Path to folder where resultset should be placed. | ||||||
| - `start_year` : RME run start year. | ||||||
| - `end_year` : RME run end year. | ||||||
| - `batch_size` : Number of repetitions to be run in each batch. | ||||||
| - `RCP_scen` : RCP scenario to be used for RME runs. | ||||||
| - `gcm` : GCM to be used for RME runs. | ||||||
| - `rnd_seed` : Random seed. | ||||||
|
There was a problem hiding this comment. Prefer to accept an RNG instead:
Suggested change
|
||||||
| """ | ||||||
| function run_rme( | ||||||
| rme_path::String, | ||||||
| n_threads::Int64, | ||||||
| reps::Int64, | ||||||
| result_path::String; | ||||||
| start_year::Int64=2022, | ||||||
| end_year::Int64=2099, | ||||||
| batch_size::Int64=10, | ||||||
| RCP_scen::String="SSP 2.45", | ||||||
| gcm::String="CNRM_ESM2_1", | ||||||
| rnd_seed::Int64=1234 | ||||||
| )::Nothing | ||||||
| init_rme(rme_path) | ||||||
| set_option("thread_count", n_threads) # Set number of threads | ||||||
| set_option("use_fixed_seed", 1) # Turn on use of a fixed seed value | ||||||
|
Comment on lines
+33
to
+35
There was a problem hiding this comment. I feel these should be set outside this function by the user and the settings reused across runs if possible. Currently, RME is re-initialized every time |
||||||
|
|
||||||
| # Reset RME to clear any previous runs | ||||||
| reset_rme() | ||||||
|
|
||||||
| # Initialize result store | ||||||
| result_store = ResultStore(start_year, end_year) | ||||||
| rme_results_dir = _resultset_dir_name() | ||||||
|
|
||||||
| # Use user selected seed to generate an array of seeds for each batch run | ||||||
| rnd_seeds::Vector{Int64} = _rnd_seeds(rnd_seed, batch_size, reps) | ||||||
|
|
||||||
| @info "Starting runs" | ||||||
| @info "Batch sizes: $batch_size" | ||||||
| for (batch_idx, batch_start) in enumerate(1:(batch_size):reps) | ||||||
| _run_batch( | ||||||
| batch_idx, | ||||||
| batch_start, | ||||||
| batch_size, | ||||||
| reps, | ||||||
| rnd_seeds[batch_idx], | ||||||
| rme_results_dir, | ||||||
| start_year, | ||||||
| end_year, | ||||||
| RCP_scen, | ||||||
| gcm, | ||||||
| result_store | ||||||
| ) | ||||||
| end | ||||||
| @info "Finished running all reps." | ||||||
|
|
||||||
| result_path = joinpath(result_path, rme_results_dir) | ||||||
| save_result_store(result_path, result_store) | ||||||
|
|
||||||
| return nothing | ||||||
| end | ||||||
|
|
||||||
| """ | ||||||
| run_batch(batch_idx::Int64, batch_start::Int64, batch_size::Int64, reps::Int64, rme_results_dir::String, start_year::Int64, end_year::Int64, RCP_scen::String, gcm::String, result_store)::Nothing | ||||||
|
|
||||||
| Run one batch of repetitions using RME. | ||||||
| """ | ||||||
| function _run_batch( | ||||||
| batch_idx::Int64, | ||||||
| batch_start::Int64, | ||||||
| batch_size::Int64, | ||||||
| reps::Int64, | ||||||
| batch_seed::Int64, | ||||||
| rme_results_dir::String, | ||||||
| start_year::Int64, | ||||||
| end_year::Int64, | ||||||
| RCP_scen::String, | ||||||
| gcm::String, | ||||||
| result_store | ||||||
| )::Nothing | ||||||
| batch_end = batch_start - 1 + batch_size | ||||||
| batch_reps = if batch_end > reps | ||||||
| reps - (batch_start - 1) | ||||||
| else | ||||||
| batch_size | ||||||
| end | ||||||
|
|
||||||
| @info "Starting batch $batch_idx" | ||||||
|
|
||||||
| # Set distinct seed for each run | ||||||
| set_option("fixed_seed", batch_seed) # Set the fixed seed value | ||||||
|
|
||||||
| # Note: if Julia runtime crashes, check that specified data file location is correct | ||||||
| @RME runCreate( | ||||||
| rme_results_dir::Cstring, | ||||||
| start_year::Cint, | ||||||
| end_year::Cint, | ||||||
| RCP_scen::Cstring, | ||||||
| gcm::Cstring, | ||||||
| batch_reps::Cint | ||||||
| )::Cint | ||||||
|
|
||||||
| # Initialize RME runs as defined above | ||||||
| run_init() | ||||||
|
|
||||||
| # Run all years and all reps | ||||||
| @time @RME runProcess()::Cint | ||||||
|
|
||||||
| # Collect and store results | ||||||
| @info "Concatenating results of batch $batch_idx..." | ||||||
| concat_results!(result_store, start_year, end_year, batch_reps) | ||||||
|
|
||||||
| return nothing | ||||||
| end | ||||||
|
|
||||||
| function _rnd_seeds(rnd_seed::Int64, batch_size::Int64, reps::Int64)::Vector{Int64} | ||||||
| Random.seed!(rnd_seed) | ||||||
| n_seeds = Int(ceil(reps / batch_size)) | ||||||
| return Int.(floor.(rand(n_seeds) .* 1e6)) | ||||||
| end | ||||||
|
Comment on lines
+125
to
+129
There was a problem hiding this comment. I think use function _rnd_seeds(rnd_seed::Int64, batch_size::Int64, reps::Int64; rng::AbstractRNG=Random.GLOBAL_RNG, max_seed::Int64=1_000_000)::Vector{Int64}
n_seeds = Int(ceil(reps / batch_size))
if n_seeds > max_seed
# Protect against possibly number of seed values exceed seed range
max_seed = max_seed + (n_seeds * 2)
end
return sample(rng, 1:max_seed, n_seeds; replace=false)
end |
||||||
|
|
||||||
| function _resultset_dir_name()::String | ||||||
| timestamp = Dates.format(now(), "yyyymmdd_HHMMSS") | ||||||
|
There was a problem hiding this comment. I prefer |
||||||
| return "rme_results_$(timestamp)" | ||||||
| end | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we move the RME option setting step outside this function as suggested below, we can remove this (and other) argument lines, but if we decide to keep it: