From c4801b47a24377915d49b486dcde3621601ab1b3 Mon Sep 17 00:00:00 2001 From: lrennels Date: Thu, 23 May 2019 16:26:02 -0700 Subject: [PATCH 1/3] Add sim modification functions to userguide --- docs/src/internals/montecarlo.md | 11 +++++++++++ docs/src/reference.md | 10 ++++++++++ docs/src/tutorials/tutorial_4.md | 13 ++++++++++++- 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/src/internals/montecarlo.md b/docs/src/internals/montecarlo.md index b1f856827..38748671a 100644 --- a/docs/src/internals/montecarlo.md +++ b/docs/src/internals/montecarlo.md @@ -316,3 +316,14 @@ generate_trials!(sim, N, filename=joinpath(output_dir, "trialdata.csv")) set_models!(sim, m) run_sim(sim, output_dir=output_dir) ``` +### Simulation Modification Functions +A small API is available to modify an existing [Simulation](@ref). The functions include: +* [deleteRV!](@ref) +* [addRV!](@ref) +* [replaceRV!](@ref) +* [deleteTransform!](@ref) +* [addTransform!](@ref) +* [deleteSave!](@ref) +* [addSave!](@ref) +* [set_payload!](@ref) +* [payload](@ref) diff --git a/docs/src/reference.md b/docs/src/reference.md index 34d77ff88..24e299c74 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -4,10 +4,17 @@ @defcomp MarginalModel Model +Simulation add_comp! +addRV! +addSave! +addTransform! components connect_param! create_marginal_model +deleteRV! +deleteSave! +deleteTransform! dim_count dim_keys dim_key_dict @@ -30,13 +37,16 @@ new_comp parameters parameter_names parameter_dimensions +payload plot_comp_graph replace_comp! +replaceRV! run_sim set_dimension! set_leftover_params! set_models! set_param! +set_payload! variables variable_dimensions variable_names diff --git a/docs/src/tutorials/tutorial_4.md b/docs/src/tutorials/tutorial_4.md index 829131d3c..20aa3a6db 100644 --- a/docs/src/tutorials/tutorial_4.md +++ b/docs/src/tutorials/tutorial_4.md @@ -90,7 +90,7 @@ of all scenario value vectors. In situations in which you want the SA loop to ru some of the models, the remainder of the runs can be handled using a `pre_trial_func` or `post_trial_func`. -### Step 2. Generate Trials +### Step 3. Generate Trials The [`generate_trials!`](@ref) function generates all trial data, and save all random variable values in a file. Employ this function as follows: @@ -262,3 +262,14 @@ set_models!(mcs, [base, marginal]) generate_trials!(mcs, N; filename = "ecs_sample.csv") run_sim!(mcs; post_trial_func = my_scc_calculation) ``` +## Simulation Modification Functions +A small API is available to modify an existing [Simulation](@ref). The functions include: +* [deleteRV!](@ref) +* [addRV!](@ref) +* [replaceRV!](@ref) +* [deleteTransform!](@ref) +* [addTransform!](@ref) +* [deleteSave!](@ref) +* [addSave!](@ref) +* [set_payload!](@ref) +* [payload](@ref) \ No newline at end of file From f3efafc14a8b3c0edf47e8e97f498a73d5d1453d Mon Sep 17 00:00:00 2001 From: lrennels Date: Thu, 23 May 2019 16:41:36 -0700 Subject: [PATCH 2/3] Remove new_comp from exported fcns and reference list --- docs/src/reference.md | 1 - src/Mimi.jl | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/src/reference.md b/docs/src/reference.md index 24e299c74..e87fb20cd 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -33,7 +33,6 @@ is_timestep load_comps modeldef name -new_comp parameters parameter_names parameter_dimensions diff --git a/src/Mimi.jl b/src/Mimi.jl index ab0203da0..30dff449c 100644 --- a/src/Mimi.jl +++ b/src/Mimi.jl @@ -35,7 +35,6 @@ export load_comps, modeldef, name, - new_comp, parameters, parameter_dimensions, parameter_names, From 70a2265c956c210e1b4f2fc6d9c93532e4603535 Mon Sep 17 00:00:00 2001 From: lrennels Date: Thu, 23 May 2019 17:51:45 -0700 Subject: [PATCH 3/3] Do not export sim modification functions --- docs/src/internals/montecarlo.md | 20 ++++++++++---------- docs/src/reference.md | 9 --------- docs/src/tutorials/tutorial_4.md | 20 ++++++++++---------- 3 files changed, 20 insertions(+), 29 deletions(-) diff --git a/docs/src/internals/montecarlo.md b/docs/src/internals/montecarlo.md index 38748671a..1c5a942b6 100644 --- a/docs/src/internals/montecarlo.md +++ b/docs/src/internals/montecarlo.md @@ -317,13 +317,13 @@ set_models!(sim, m) run_sim(sim, output_dir=output_dir) ``` ### Simulation Modification Functions -A small API is available to modify an existing [Simulation](@ref). The functions include: -* [deleteRV!](@ref) -* [addRV!](@ref) -* [replaceRV!](@ref) -* [deleteTransform!](@ref) -* [addTransform!](@ref) -* [deleteSave!](@ref) -* [addSave!](@ref) -* [set_payload!](@ref) -* [payload](@ref) +A small set of unexported functions are available to modify an existing `Simulation`. The functions include: +* `deleteRV!` +* `addRV!` +* `replaceRV!` +* `deleteTransform!` +* `addTransform!` +* `deleteSave!` +* `addSave!` +* `set_payload!` +* `payload` diff --git a/docs/src/reference.md b/docs/src/reference.md index e87fb20cd..9223e1449 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -4,17 +4,10 @@ @defcomp MarginalModel Model -Simulation add_comp! -addRV! -addSave! -addTransform! components connect_param! create_marginal_model -deleteRV! -deleteSave! -deleteTransform! dim_count dim_keys dim_key_dict @@ -36,7 +29,6 @@ name parameters parameter_names parameter_dimensions -payload plot_comp_graph replace_comp! replaceRV! @@ -45,7 +37,6 @@ set_dimension! set_leftover_params! set_models! set_param! -set_payload! variables variable_dimensions variable_names diff --git a/docs/src/tutorials/tutorial_4.md b/docs/src/tutorials/tutorial_4.md index 20aa3a6db..43368abd5 100644 --- a/docs/src/tutorials/tutorial_4.md +++ b/docs/src/tutorials/tutorial_4.md @@ -263,13 +263,13 @@ generate_trials!(mcs, N; filename = "ecs_sample.csv") run_sim!(mcs; post_trial_func = my_scc_calculation) ``` ## Simulation Modification Functions -A small API is available to modify an existing [Simulation](@ref). The functions include: -* [deleteRV!](@ref) -* [addRV!](@ref) -* [replaceRV!](@ref) -* [deleteTransform!](@ref) -* [addTransform!](@ref) -* [deleteSave!](@ref) -* [addSave!](@ref) -* [set_payload!](@ref) -* [payload](@ref) \ No newline at end of file +A small set of unexported functions are available to modify an existing `Simulation`. The functions include: +* `deleteRV!` +* `addRV!` +* `replaceRV!` +* `deleteTransform!` +* `addTransform!` +* `deleteSave!` +* `addSave!` +* `set_payload!` +* `payload`