Skip to content

Commit

Permalink
Export useful things
Browse files Browse the repository at this point in the history
  • Loading branch information
nefrathenrici committed Jul 8, 2024
1 parent 8fd8e55 commit 48d47f1
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ ClimaCalibrate.observation_map
## Backend Interface

```@docs
ClimaCalibrate.get_backend
ClimaCalibrate.calibrate
ClimaCalibrate.sbatch_model_run
```
Expand All @@ -25,4 +26,6 @@ ClimaCalibrate.ExperimentConfig
ClimaCalibrate.get_prior
ClimaCalibrate.get_param_dict
ClimaCalibrate.path_to_iteration
ClimaCalibrate.path_to_ensemble_member
ClimaCalibrate.path_to_model_log
```
2 changes: 2 additions & 0 deletions src/backends.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
export get_backend, calibrate

abstract type AbstractBackend end

struct JuliaBackend <: AbstractBackend end
Expand Down
3 changes: 2 additions & 1 deletion src/ekp_interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import EnsembleKalmanProcesses as EKP
using EnsembleKalmanProcesses.ParameterDistributions
using EnsembleKalmanProcesses.TOMLInterface

export ExperimentConfig
export ExperimentConfig, get_prior, initialize, update_ensemble, save_G_ensemble
export path_to_ensemble_member, path_to_model_log, path_to_iteration

"""
ExperimentConfig(
Expand Down
1 change: 1 addition & 0 deletions src/model_interface.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import EnsembleKalmanProcesses as EKP
import YAML

export set_up_forward_model, run_forward_model, observation_map

"""
set_up_forward_model(member, iteration, experiment_dir::AbstractString)
Expand Down
2 changes: 2 additions & 0 deletions src/slurm.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
export kwargs, sbatch_model_run, wait_for_jobs

kwargs(; kwargs...) = Dict{Symbol, Any}(kwargs...)

"""
Expand Down

0 comments on commit 48d47f1

Please sign in to comment.