Skip to content

Commit

Permalink
Merge #2067
Browse files Browse the repository at this point in the history
2067: Clean up warnings in docs r=Sbozzolo a=Sbozzolo

The documentation is generated with a few warnings and one error (see, e.g., https://github.com/CliMA/ClimaAtmos.jl/actions/runs/6101954504/job/16559376893#step:5:8).

The error is due to an incompatibility between `doctest` and `CitationBibliography`. I reported the problem upstream. The error is not fatal.

Co-authored-by: Gabriele Bozzola <gbozzola@caltech.edu>
  • Loading branch information
bors[bot] and Sbozzolo authored Sep 7, 2023
2 parents f9ef74d + 168c0a8 commit 17d9571
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ClimaAtmos.TurbulenceConvection.Parameters

## Initial conditions

### General
### General

```@docs
ClimaAtmos.InitialConditions.InitialCondition
Expand Down
14 changes: 1 addition & 13 deletions docs/src/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,8 @@ alias = "grav"
value = 9.81
type = "float"
```
For more info on formatting the TOML, see [here]([https://clima.github.io/CLIMAParameters.jl/dev/toml/](https://clima.github.io/CLIMAParameters.jl/dev/toml/)).
For more info on formatting the TOML, see [here](https://clima.github.io/CLIMAParameters.jl/dev/toml/).


# After CLI Removal:
Once you have created your parameter file (`parameters.toml`), you must create a separate YAML configuration file (`config.yaml`).
In the config file, enter:
```
Expand All @@ -30,13 +28,3 @@ toml: parameters.toml
In order to run the model, type: `julia --project=examples --config_file config.yaml`.
Note that the `--config_file` argument can take several config files, so if you have a separate config file you would like to use,
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.

# Pre-CLI removal:
To run the model, you can either initialize the model interactively from the Julia REPL or from the command-line.
From the command-line at the top-level CA directory, just run `julia --project=examples --toml path/to/toml`

If running the model interactively, you can change `ARGS` and append `["--toml", "path/to/toml"]`.
Alternatively, you can create the `parsed_args` dictionary and manually alter it yourself: `parsed_args["toml"] = "path/to/toml"`.

If you are just overriding a parameter, you can just create the model config and run the model!
If you add a new parameter, you need to alter the [ClimaAtmosParameters]([https://github.com/CliMA/ClimaAtmos.jl/blob/main/src/parameters/Parameters.jl](https://github.com/CliMA/ClimaAtmos.jl/blob/main/src/parameters/Parameters.jl#L13)) struct to include your parameter. This can temporarily be done at the top level if you need to test something quickly, but if you want to merge the code, it is best to place your new parameter inside one of the nested parameter structs.
4 changes: 2 additions & 2 deletions src/initial_conditions/initial_conditions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ end
"""
GABLS
The `InitialCondition` described in [Kosovic2000](cite), but with a hydrostatically
The `InitialCondition` described in [Kosovic2000](@cite), but with a hydrostatically
balanced pressure profile.
"""
Base.@kwdef struct GABLS <: InitialCondition
Expand Down Expand Up @@ -777,7 +777,7 @@ end
"""
Rico
The `InitialCondition` described in [Rauber2007](cite), but with a hydrostatically
The `InitialCondition` described in [Rauber2007](@cite), but with a hydrostatically
balanced pressure profile.
"""
Base.@kwdef struct Rico <: InitialCondition
Expand Down

0 comments on commit 17d9571

Please sign in to comment.