Skip to content

Commit c14a4eb

Browse files
committed
remove examples project.toml
1 parent a9a8713 commit c14a4eb

File tree

14 files changed

+22
-131
lines changed

14 files changed

+22
-131
lines changed

docs/src/config_no_table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The only exception is true/false strings. These need quotes around them, or they
77

88
To start the model with a custom configuration, run:
99

10-
`julia --project=examples examples/hybrid/driver.jl --config_file <yaml>`
10+
`julia --project=.buildkite .buildkite/ci_driver.jl --config_file <yaml>`
1111

1212
### Example
1313
Below is the default Bomex configuration:

docs/src/parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ In the config file, enter:
2323
```
2424
toml: parameters.toml
2525
```
26-
In order to run the model, type: `julia --project=examples --config_file config.yaml`.
26+
In order to run the model, type: `julia --project=.buildkite --config_file config.yaml`.
2727
Note that the `--config_file` argument can take several config files, so if you have a separate config file you would like to use,
2828
you can simply add it to the end of the command line arguments. Alternatively, you can just add your TOML config to the existing config file.

docs/src/radiative_equilibrium.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ job_id: "single_column_radiative_equilibrium_clearsky_prognostic_surface_temp"
2828

2929
Then run the simulation with the following command:
3030
```
31-
julia --project=examples examples/hybrid/driver.jl --config_file path_to_mysim.yml
31+
julia --project=.buildkite .buildkite/ci_driver.jl --config_file path_to_mysim.yml
3232
```
3333

3434
The configuration in the yaml file above can be changed to adjust to the kind of simulation desired. Options such as t\_end can be increased to the desired simulation time. Other arguments such as radiation type can be changed based on the options in `default_config.yml`.
3535

3636
After a simulation is ran the output files should be available in the output folder, where hdf5 files store all the simulation's data, and two mp4s should be produced with a vertical temperature profile and a vertical wind profile which change over time. If you want to quickly access data from the final day of the simulation simply add a -i to the command line input, like so:
3737

3838
```
39-
julia -i --project=examples examples/hybrid/driver.jl --config_file filepath
39+
julia -i --project=.buildkite .buildkite/ci_driver.jl --config_file filepath
4040
```
4141

4242
This will bring you into a julia environment where the current state of the simulation can be accessed. Run propertynames(Y) and propertynames(p) to see accessible values, some examples:

docs/src/repl_scripts.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ function print_repl_script(config)
1818
ib *= """\n"""
1919
ib *= """config = CA.AtmosConfig(config_dict);\n"""
2020
ib *= """\n"""
21-
ib *= """include("examples/hybrid/driver.jl")\n"""
21+
ib *= """include(".buildkite/ci_driver.jl")\n"""
2222
println(ib)
2323
end
2424

docs/src/single_column_prospect.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515

1616
For example, to run the BOMEX test case execute the following:
1717
```bash
18-
julia --project=examples examples/hybrid/driver.jl --config_file config/model_configs/prognostic_edmfx_bomex_column.yml --job_id bomex
18+
julia --project=.buildkite .buildkite/ci_driver.jl --config_file config/model_configs/prognostic_edmfx_bomex_column.yml --job_id bomex
1919
```
20-
It may also be helpful to run in interactive mode to be able to examine the simulation object, debug, and develop the code further. To enter debug mode run `julia --project=examples` and then in the REPL run:
20+
It may also be helpful to run in interactive mode to be able to examine the simulation object, debug, and develop the code further. To enter debug mode run `julia --project=.buildkite` and then in the REPL run:
2121
```julia
2222
using Revise # if you are developing ClimaAtmos
2323
import ClimaAtmos as CA
@@ -33,7 +33,7 @@ Currently three versions of the externally driven single column model, `GCM` dri
3333
### GCM-Driven Case
3434
For the `GCM` driven case we can run the experiment using the config file `config/model_configs/prognostic_edmfx_gcmdriven_column.yml` by running:
3535
```bash
36-
julia --project=examples examples/hybrid/driver.jl --config_file config/model_configs/prognostic_edmfx_gcmdriven_column.yml --job_id gcm_driven_scm
36+
julia --project=.buildkite .buildkite/ci_driver.jl --config_file config/model_configs/prognostic_edmfx_gcmdriven_column.yml --job_id gcm_driven_scm
3737
```
3838
In the config the following settings are particularly important:
3939
```YAML
@@ -64,7 +64,7 @@ By this point, the first 4 entries are intuitive. We need to dispatch over each
6464

6565
The data is generated by downloading from ECMWF and further documentation for ERA5 data download can be found either directly on the ECMWF page and `ClimaArtifacts.jl`. Note that the profiles, surface temperature, and surface fluxes cannot be obtained from a single request and so together we need 3 files for all the data. We include a script at `src/utils/era5_observations_to_forcing_file.jl` which extracts the profiles and computes the tendencies needed for the simulation from the raw ERA5 reanalysis files. We store the observations directly into an artifact `era5_hourly_atmos_processed` to eliminate the need to reprocess specific sites and locations. This setup means that users are free to choose sites globally at any time at which ERA5 data is available. Unfortunately, global hourly renanalysis is too large to store in an artifact and so we have currently only provided support for the first 5 days of July 2007 in the tropical Pacific, stored in `era5_hourly_atmos_raw`, only available on the `clima` and Caltech `HPC` servers. The test case can be run using:
6666
```bash
67-
julia --project=examples examples/hybrid/driver.jl --config_file config/model_configs/prognostic_edmfx_tv_era5driven_column.yml --job_id era5driven
67+
julia --project=.buildkite .buildkite/ci_driver.jl --config_file config/model_configs/prognostic_edmfx_tv_era5driven_column.yml --job_id era5driven
6868
```
6969

7070
#### Monthly Averaged Forcing
@@ -79,7 +79,7 @@ site_latitude: 17.0
7979
site_longitude: -149.0
8080
```
8181
```bash
82-
julia --project=examples examples/hybrid/driver.jl --config_file config/model_configs/prognostic_edmfx_diurnal_scm_imp.yml --job_id bomex
82+
julia --project=.buildkite .buildkite/ci_driver.jl --config_file config/model_configs/prognostic_edmfx_diurnal_scm_imp.yml --job_id bomex
8383
```
8484

8585
#### Running the Reanalysis-driven cases at different times and locations

examples/Project.toml

Lines changed: 0 additions & 86 deletions
This file was deleted.

examples/hybrid/driver.jl

Lines changed: 0 additions & 23 deletions
This file was deleted.

perf/benchmark_step.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#=
22
Run this script with, for example:
33
```
4-
julia --project=examples perf/benchmark_step.jl --h_elem 6
4+
julia --project=.buildkite perf/benchmark_step.jl --h_elem 6
55
```
66
Or, interactively,
77
```
8-
julia --project=examples
8+
julia --project=.buildkite
99
push!(ARGS, "--h_elem", "6")
1010
# push!(ARGS, "--device", "CPUSingleThreaded") # uncomment to run on CPU
1111
include(joinpath("perf", "benchmark_step.jl"));

perf/invalidations.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ using SnoopCompileCore
88
invalidations = @snoop_invalidations begin
99
(; config_file, job_id) = CA.commandline_kwargs()
1010
config = CA.AtmosConfig(config_file; job_id)
11-
include(joinpath(dirname(@__DIR__), "examples", "hybrid", "driver.jl"))
11+
include(joinpath(dirname(@__DIR__), ".buildkite", "ci_driver.jl"))
1212
nothing
1313
end;
1414

reproducibility_tests/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document outlines how reproducibility tests work and how to update PRs to p
44

55
## The basic idea of how reproducibility tests work
66

7-
When a particular job opts-in to testing reproducibilitys (using the `reproducibility_test` command line option and the `julia --project=examples reproducibility_tests/test_mse.jl` command), we compare the solution dataset (the prognostic state at the last timestep) of that job with a reference dataset.
7+
When a particular job opts-in to testing reproducibilitys (using the `reproducibility_test` command line option and the `julia --project=.buildkite reproducibility_tests/test_mse.jl` command), we compare the solution dataset (the prognostic state at the last timestep) of that job with a reference dataset.
88

99
We don't always have a reference to compare against, due to what we'll call **failure modes**. For a full list of failure modes, see [Failure modes](#Failure-modes), but here are a few examples:
1010

@@ -45,7 +45,7 @@ Note: We currently do not prepend the folder names by the reference counter, how
4545

4646
## Allowing flaky tests
4747

48-
Users can add the flag `test_broken_report_flakiness` to the `test_mse.jl` script: `julia --project=examples reproducibility_tests/test_mse.jl --test_broken_report_flakiness true`, which will have the following behavior:
48+
Users can add the flag `test_broken_report_flakiness` to the `test_mse.jl` script: `julia --project=.buildkite reproducibility_tests/test_mse.jl --test_broken_report_flakiness true`, which will have the following behavior:
4949

5050
- If the test is not reproducible (i.e., flaky) when compared against `N` comparable references, then the test will pass and be reported as broken.
5151
- If the test is reproducible when compared against `N` comparable references, then the test will fail `@test_broken`, and users will be asked to fix the broken test. At which point you can remove the `--test_broken_report_flakiness true` flag from that particular job, reinforcing a strict reproducibility constraint.
@@ -64,7 +64,7 @@ To update the mse tables:
6464

6565
To add a new reproducibility test:
6666

67-
- Set the command-line `reproducibility_test` to true, and add `julia --color=yes --project=examples reproducibility_tests/test_mse.jl --job_id [job_id] --out_dir [job_id]` as a separate command for the new (or existing) job
67+
- Set the command-line `reproducibility_test` to true, and add `julia --color=yes --project=.buildkite reproducibility_tests/test_mse.jl --job_id [job_id] --out_dir [job_id]` as a separate command for the new (or existing) job
6868
- Copy the `all_best_mse` dict template from the job's log
6969
- Paste the `all_best_mse` dict template into `reproducibility_test/reproducibility_test_job_ids.jl`
7070

@@ -90,7 +90,7 @@ We cannot (easily) compare the output with a reference if we change the spatial
9090

9191
## A detailed procedure of how reproducibility tests are performed
9292

93-
Reprodicibility tests are performed at the end of `examples/hybrid/driver.jl`, after a simulation completes, and relies on a unique job id (`job_id`). Here is an outline of the reproducibility test procedure:
93+
Reprodicibility tests are performed at the end of `.buildkite/ci_driver.jl`, after a simulation completes, and relies on a unique job id (`job_id`). Here is an outline of the reproducibility test procedure:
9494

9595
0) Run a simulation, with a particular `job_id`, to the final time.
9696
1) Load a list of job IDs in `reproducibility_test_job_ids.jl`.

0 commit comments

Comments
 (0)