Skip to content

Commit

Permalink
format + more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nefrathenrici committed Nov 7, 2023
1 parent a5c9238 commit 30975bd
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
21 changes: 18 additions & 3 deletions docs/src/experiment_setup_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,32 @@ Please read this entire guide before setting up an experiment.

## Summary

The overall pipeline is as follows:

Observations are generated (or obtained) and then processed through the observation map.
For the example experiment, `sphere_held_suarez_rhoe_equilmoist`, this is done by running
`sbatch experiments/sphere_held_suarez_rhoe_equilmoist/generate_observations.sbatch`.

Once the observations have been processed, the actual calibration pipeline can be run via
`bash job_array.sh sphere_held_suarez_rhoe_equilmoist 8`.
The command line interface will change, but for now, the first entry is the experiment id and the second is the number of tasks to use per ensemble member.

This consists of three `sbatch` scripts:
- `initialize.sbatch` initializes the Julia project and the ensemble
- `model_run.sbatch` runs an individual forward model
- `update.sbatch` performs the update step and sets up the next iteration

To calibrate parameters, you need:
- Atmos model configuration
- Steady-state restart file
- EKP configuration
- Prior parameter distributions
- Steady-state restart file
- Truth and noise data JLD2 files
- Observation map script with a function `observation_map(iteration)`

Examples of all of these can be found in `experiments/sphere_held_suarez_rhoe_equilmoist`
These components are detailed in the guide below. Examples of all of these can also be found in `experiments/sphere_held_suarez_rhoe_equilmoist`

First, create a folder for your experiment with a descriptive job id in the `experiments/` folder. All of the components described below will be stored in this folder. An existing example is found in `experiments/sphere_held_suarez_rhoe_equilmoist`. This experiment has examples for each component.
First, create a folder for your experiment with a descriptive job id in the `experiments/` folder. All of the components described below will be stored in this folder.

## Atmos Configuration File
This is the ClimaAtmos configuration which will be used to run all simulations in the calibration. The only changes between model runs are the parameters selected for calibration.
Expand Down
2 changes: 1 addition & 1 deletion src/ekp_interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ using EnsembleKalmanProcesses.TOMLInterface
path_to_iteration(output_dir, iteration)
Returns the path to the iteration folder within `output_dir` for the given iteration number.
"""
path_to_iteration(output_dir, iteration) =
path_to_iteration(output_dir, iteration) =
joinpath(output_dir, join(["iteration", lpad(iteration, 3, "0")], "_"))

"""
Expand Down

0 comments on commit 30975bd

Please sign in to comment.