Skip to content

Commit

Permalink
Updated custom tags. Added function to automatically add simulation t…
Browse files Browse the repository at this point in the history
…erminal info admonitions to pages with simulated terminals. Updated REAMDE

Updated README

Updated README

Updated README

Updated README

Adding Heidi's reviews
  • Loading branch information
atteggiani committed May 6, 2024
1 parent e87ecd2 commit ced4256
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 19 deletions.
16 changes: 0 additions & 16 deletions docs/js/custom-tags.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,6 @@ class SimulatedTerminalInfo extends HTMLElement {
}
}

// Create an HTML tag to render the simulated terminal info admonition
class SimulatedTerminalInfo extends HTMLElement {
constructor() {
super();
this.outerHTML = `<div class="admonition info">
In this documentation, the same code is sometimes shown in a highlighted code-block
and also in a simulated terminal.<br>
The <b>code-blocks</b> show the commands to be run in a terminal. They can be easily copied
by clicking on the icon over the right side of the code block.<br>
The <b>simulated terminals</b> are examples of the output to expect when the commands are
run. Sometimes they might slightly differ from the real outputs.
</div>
`
}
}

// Create an HTML tag to render the references
class References extends HTMLElement {
constructor() {
Expand Down
4 changes: 1 addition & 3 deletions docs/models/run-a-model/run-access-esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

# Run {{ model }}

<custom-simulated-terminal-info/>

## Prerequisites

### General prerequisites
Expand Down Expand Up @@ -326,7 +324,7 @@ payu run -f
This will submit a single job to the queue with a _total experiment length_ of `runtime`. If there is no previous run, it will start from the [`start`](#runtime) date indicated in the `config.yaml` file. Otherwise, it will perform a warm restart from a previously saved restart file.<br>
!!! tip
The option `-f` ensures that _payu_ will run even if there is an existing non-empty `work` directory created from a previous failed run.
The `-f` option ensures that _payu_ will run even if there is an existing non-empty `work` directory created from a previous failed run.
<terminal-window>
<terminal-line data="input">payu run -f</terminal-line>
Expand Down

0 comments on commit ced4256

Please sign in to comment.