Skip to content

Commit

Permalink
Clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
nefrathenrici committed Nov 1, 2023
1 parent 563bb7b commit c028d21
Show file tree
Hide file tree
Showing 22 changed files with 94 additions and 1,793 deletions.
3 changes: 1 addition & 2 deletions .dev/up_deps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ dirs = (
root,
joinpath(root, "test"),
joinpath(root, ".dev"),
joinpath(root, "perf"),
joinpath(root, "docs"),
joinpath(root, "examples"),
joinpath(root, "experiments"),
)

cd(root) do
Expand Down
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ makedocs(
collapselevel = 1,
mathengine = MathJax3(),
),
pages = ["Home" => "index.md"],
pages = ["Home" => "index.md", "Getting Started" => "quickstart.md"],
)

deploydocs(
Expand Down
14 changes: 14 additions & 0 deletions docs/src/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Getting Started

There is currently one example experiment with the job id `sphere_held_suarez_rhoe_equilmoist`.
It is a perfect-model calibration, serving as a test case for the initial pipeline.

This experiment runs the Held-Suarez configuration, estimating the parameter `equator_pole_temperature_gradient_wet`.
By default, it runs 10 ensemble members for 4 iterations.
Each forward model runs using 8 tasks, with 8 cpus per task for a total of 64 cpus per model run.

To run this experiment:
1. Log onto the Caltech HPC
2. Clone CalibrateAtmos.jl and `cd` into the repository.
3. Run: `./experiments/job_array.sh sphere_held_suarez_rhoe_equilmoist`

Loading

0 comments on commit c028d21

Please sign in to comment.