Skip to content

Commit 7936bb5

Browse files
committed
Updated information about setup env and render ci scripts.
1 parent 663ef6e commit 7936bb5

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

site/guidelines-authors.qmd

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,24 +203,28 @@ You can safely delete the `gh-pages` branch if you have one, as we don't need an
203203

204204
#### Handle external *system* dependencies
205205

206-
While you should have by now handled R, Python or Julia package dependencies using appropriate tools that register environments and version numbers, some of the packages your work depend upon might require external system dependencies that must be installed either when setting up the environment in the github runner or when taking care of the paper rendering or in both cases. To take care of that, you can add and customize two scripts at the root of your repository. Specifically:
206+
While you should have by now handled R, Python or Julia package dependencies using appropriate tools that register environments and version numbers, some of the packages your work depend upon might require external *system* dependencies that must be installed either when setting up the environment in the GitHub runner or when taking care of the paper rendering or in both cases. To take care of that, you can add and customize two scripts at the root of your repository. Specifically:
207207

208-
- `setup-env-ci.sh` is for setting up the environment and typically adding system dependencies. The virtual machine on GitHub (runner) may need to install some packages with `apt-get` for R or Python packages. Here is an example of such a file taken from @giorgi2024:
208+
- `setup-env-ci.sh` is meant to install system dependencies required to set up the environment in the GitHub runner. Here is an example of such a file taken from @giorgi2024:
209209

210210
```bash
211211
# The CI runs on Linux Ubuntu, here goes system dependencies
212212
# needed at environment setup step
213213
sudo apt-get install -y libcurl4-openssl-dev
214214
```
215215

216-
- `setup-render-ci.sh` is for taking care of specific dependencies outside of quarto, related to rendering, like plotting software or running a script to generate data. Here is an example of such a file taken from @giorgi2024:
216+
- `setup-render-ci.sh` is meant to install system dependencies required for rendering the paper, like plotting software or running a script to generate data. Here is an example of such a file taken from @giorgi2024:
217217

218218
```bash
219219
# The CI runs on Linux Ubuntu, here goes system dependencies
220220
# needed at rendering step
221221
sudo apt-get install -y libblas-dev liblapack-dev
222222
```
223223

224+
::: {.callout-warning title="Ubuntu GitHub runner"}
225+
Remember that the GitHub runner uses Linux Ubuntu and therefore software installation is achieved through `apt-get`. Furthermore, you should prepend calls to `apt-get` with the `sudo` word to specify that you want to execute this command as administrator of the machine.
226+
:::
227+
224228
### Submit your manuscript {#sec-submitting}
225229

226230
Once you are done writing your contribution, recall that you can render it in both HTML and PDF by running `quarto render .` from a terminal within the folder in which you cloned the Computo template.

0 commit comments

Comments
 (0)