You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/guidelines-authors.qmd
+9-10Lines changed: 9 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ The [Computo](https://github.com/computorg) organization provides template repos
25
25
26
26
### Setup a git repository {#sec-git}
27
27
28
-
Setup a new github repository by going on the URL of either the R or Python or Julia template repository and clicking on the **"use this template"** button on the top of the page, as illustrated in @fig-template.
28
+
Setup a new Github repository by going on the URL of either the R or Python or Julia template repository and clicking on the **"use this template"** button on the top of the page, as illustrated in @fig-template.
29
29
30
30
{#fig-template width="100%"}
31
31
@@ -82,7 +82,7 @@ To build your document (both in PDF and HTML by default), you can run the comman
82
82
83
83
```bash
84
84
# will render both to html and PDF
85
-
quarto render template-computo-{R,python,julia}.qmd
85
+
quarto render
86
86
```
87
87
88
88
#### Metadata of your contribution
@@ -195,7 +195,7 @@ Next, as illustrated in @fig-deploy, under `Settings > Pages` on the webpage of
195
195
196
196
{#fig-deploy width="100%"}
197
197
198
-
Authors can find more detailed about Computo's workflow in @sec-workflow.
198
+
Authors can find more details about Computo's workflow in @sec-workflow.
199
199
200
200
::: {.callout-note title="Compatibility with old reproducibility system"}
201
201
You can safely delete the `gh-pages` branch if you have one, as we don't need anymore to push the HTML files to the site.
@@ -205,15 +205,15 @@ You can safely delete the `gh-pages` branch if you have one, as we don't need an
205
205
206
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:
207
207
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:
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 a published article:
209
209
210
210
```bash
211
211
# The CI runs on Linux Ubuntu, here goes system dependencies
212
212
# needed at environment setup step
213
213
sudo apt-get install -y libcurl4-openssl-dev
214
214
```
215
215
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:
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 a published article:
217
217
218
218
```bash
219
219
# The CI runs on Linux Ubuntu, here goes system dependencies
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.
225
+
Remember that the GitHub runner uses Linux Ubuntu and therefore software installation is achieved through `apt-get`. Furthermore, you must precede calls to `apt-get` with the word `sudo` to indicate that you wish to run this command as an administrator.
226
226
:::
227
227
228
228
### Submit your manuscript {#sec-submitting}
229
229
230
-
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.
230
+
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.
231
231
232
232
If the Quarto rendering is successful locally (hence you get both HTML and PDF files), then, once you push the last modification to your repository on GitHub, the continuous integration and deployment scripts should automatically run and, if successful, the HTML version of your contribution will be published online, as well as a PDF version (see "Other format" at the end of the table of content of the rendered HTML).
233
233
@@ -326,13 +326,13 @@ Authors simply use the `build.yml` workflow in their repository to trigger the c
326
326
327
327
### Reproducing an existing paper published in Computo
328
328
329
-
Our publication workflow makes it very easy for anyone to reproduce a given paper. To do that, you can first clone the repository. Then you need to install Quarto and the Computo Quarto extension in the `published-202412-giorgi-efficient` folder that the cloning step made. Finally, you can render the document. In summary, you do that with the following commands:
329
+
Our publication workflow makes it very easy for anyone to reproduce a given paper. Consider for instance the paper <https://doi.org/10.57750/sfxn-1t05> associated with the Github repository [published-202412-giorgi-efficient][https://github.com/computorg/published-202412-giorgi-efficient]. You first need to clone the repository. Then you need to install Quarto and the Computo Quarto extension in the `published-202412-giorgi-efficient` folder that the cloning step made. Finally, you can render the document. In summary, you do that with the following commands:
: Authors guarantee that they comply with the usage license of any third party contents/works (code, software, data, figures/images, documents, etc.) that were used to produce their work.
0 commit comments