Skip to content

Commit a813b8a

Browse files
committed
small typos and modif in guidelines jc
1 parent 7936bb5 commit a813b8a

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

site/guidelines-authors.qmd

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The [Computo](https://github.com/computorg) organization provides template repos
2525

2626
### Setup a git repository {#sec-git}
2727

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.
2929

3030
![Screenshot of the R Computo template GitHub page.](/assets/img/computo-template-screenshot.png){#fig-template width="100%"}
3131

@@ -82,7 +82,7 @@ To build your document (both in PDF and HTML by default), you can run the comman
8282

8383
```bash
8484
# will render both to html and PDF
85-
quarto render template-computo-{R,python,julia}.qmd
85+
quarto render
8686
```
8787

8888
#### Metadata of your contribution
@@ -195,7 +195,7 @@ Next, as illustrated in @fig-deploy, under `Settings > Pages` on the webpage of
195195

196196
![Deploy your website with GitHub Actions](/assets/img/2025-03-20-revised-github-process/depoy-github.png){#fig-deploy width="100%"}
197197

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.
199199

200200
::: {.callout-note title="Compatibility with old reproducibility system"}
201201
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
205205

206206
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 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:
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 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:
217217

218218
```bash
219219
# The CI runs on Linux Ubuntu, here goes system dependencies
@@ -222,12 +222,12 @@ sudo apt-get install -y libblas-dev liblapack-dev
222222
```
223223

224224
::: {.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.
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.
226226
:::
227227

228228
### Submit your manuscript {#sec-submitting}
229229

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.
231231

232232
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).
233233

@@ -326,13 +326,13 @@ Authors simply use the `build.yml` workflow in their repository to trigger the c
326326

327327
### Reproducing an existing paper published in Computo
328328

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:
330330

331331
```bash
332332
git clone https://github.com/computorg/published-202412-giorgi-efficient.git
333333
cd published-202412-giorgi-efficient
334334
quarto add computorg/computo-quarto-extension
335-
quarto render .
335+
quarto render
336336
```
337337

338338
## Computo's code of ethics {#sec-ethics}
@@ -367,4 +367,3 @@ Copyright/author's right/license compliance
367367

368368
: 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.
369369

370-
## References

0 commit comments

Comments
 (0)