Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nefrathenrici committed Apr 8, 2024
1 parent 3aec4ea commit c6a27fd
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/ekp_interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import ClimaComms

export ExperimentConfig


"""
ExperimentConfig(experiment_id)
Expand All @@ -26,8 +25,9 @@ export ExperimentConfig
)
ExperimentConfig stores the configuration for a specific experiment.
If kwargs are not passed in, they will be loaded from
`experiments/experiment_id/ekp_config.yml`
If just the experiment ID string is passed in, the config will be constructed from the
file `experiments/experiment_id/ekp_config.yml`.
For customizable interactive experiments, arguments can be passed in directly.
"""
struct ExperimentConfig
id::AbstractString
Expand Down Expand Up @@ -233,8 +233,6 @@ include(joinpath(experiment_path, "generate_data.jl"))
eki = CalibrateAtmos.calibrate(experiment_id)
```
"""


function calibrate(experiment_id; device = ClimaComms.device(), kwargs...)
configuration = ExperimentConfig(experiment_id; kwargs...)
return calibrate(configuration; device, kwargs...)
Expand Down

0 comments on commit c6a27fd

Please sign in to comment.