Skip to content

Commit 3240a83

Browse files
committed
References section to facilitate later embedding in templates.
1 parent d871877 commit 3240a83

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

site/guidelines-authors.qmd

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ page-layout: article
1111
bibliography: ../publications/published.bib
1212
---
1313

14-
## A step-by-step guide to submitting a paper to Computo
14+
## A step-by-step guide to submitting a paper to Computo {#sec-guide}
1515

1616
Submissions to [Computo](https://computorg.github.io) require both scientific content (typically equations, codes and figures, data) and a proof that this content is reproducible. This is achieved by means of i) a notebook system, ii) a virtual environment freezing the dependencies and iii) continuous integration (plus, if needed, an external website to store large data files such a [Zenodo](https://zenodo.org/) or [OSF](https://osf.io/)).
1717

@@ -23,7 +23,7 @@ A Computo submission is thus a Git(Hub) repository containing:
2323

2424
The [Computo](https://github.com/computorg) organization provides template repositories for [R](https://github.com/computorg/template-computo-R), [Python](https://github.com/computorg/template-computo-python) and [Julia](https://github.com/computorg/template-computo-julia) contributors. In the following sections, we detail step-by-step what authors have to do in order to format their paper for submission to Computo.
2525

26-
### Setup a git repository
26+
### Setup a git repository {#sec-git}
2727

2828
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

@@ -45,7 +45,7 @@ In summary, before clicking on *Create repository*, you should have the options
4545
You can use Gitlab for submitting to Computo. We will be giving more detailed support for this in the future.
4646
:::
4747

48-
### Setup Quarto and Computo extension on your system
48+
### Setup Quarto and Computo extension on your system {#sec-quarto}
4949

5050
You need [quarto](https://quarto.org/) installed on your computer, as well as the [Computo extension](https://github.com/computorg/computo-quarto-extension) to prepare your document.
5151

@@ -66,7 +66,7 @@ If you are collaborating with others when writing your contributions, **each col
6666
- install the Computo Quarto extension by executing the above command.
6767
:::
6868

69-
### Write your contribution
69+
### Write your contribution {#sec-writing}
7070

7171
In the forked template, there are mainly two files you are expected to modify for writing your contribution: `template-computo-LANG.qmd` (where LANG is to be replaced with either R, python or julia) and `_quarto.yml`.
7272

@@ -132,7 +132,7 @@ format:
132132
133133
You can customize most of the entries in that file except `project:`, `published:` and `format:`. If your contribution is accepted for publication, the associate editors will modify parts of this file accordingly.
134134

135-
### Setup dependencies
135+
### Setup dependencies {#sec-dependencies}
136136

137137
The next step is to inform Computo of the other packages, tools and environment that your paper might depend upon. It is important to freeze their versions to ensure reproducibility. This step is inherently handled differently whether you are an R, Python or Julia user.
138138

@@ -154,7 +154,7 @@ The next step is to inform Computo of the other packages, tools and environment
154154
{{< include _handle_dependencies_julia.qmd >}}
155155
:::
156156

157-
### Ensure reproducibility
157+
### Ensure reproducibility {#sec-reproducibility}
158158

159159
Now that you have written your contribution in the correct template and set up its dependencies, you need to set up continuous integration via GitHub Actions in order to ensure reproducibility of your work and its publication as a webpage.
160160

@@ -221,7 +221,7 @@ sudo apt-get install -y libcurl4-openssl-dev
221221
sudo apt-get install -y libblas-dev liblapack-dev
222222
```
223223

224-
### Submit your manuscript
224+
### Submit your manuscript {#sec-submitting}
225225

226226
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.
227227

@@ -231,7 +231,7 @@ The PDF version should then be submitted to the [OpenReview](https://openreview.
231231

232232
You can find more details about the scientific reviewing process in the [dedicated page](/site/guidelines-reviewers.qmd) on this website (*Reviewers* tabs).
233233

234-
### Accepted manuscript
234+
### Accepted manuscript {#sec-acceptance}
235235

236236
If your submission is accepted for publication, you will be asked to transfer the ownership of the repository that hosts your paper to the Computo GitHub organization. To do that, you must go on the main page of your repository in a web browser and click on the *Settings* tab as indicated in @fig-transfer-ownership-1.
237237

@@ -245,15 +245,15 @@ A new page opens where you need to select *Specify an organization or username*
245245

246246
![The ownership transfer page.](/assets/img/transfer-ownership.003.png){#fig-transfer-ownership-3 width="100%" fig-align="center"}
247247

248-
## Example papers
248+
## Example papers {#sec-examples}
249249

250250
Authors can find example papers for each language that illustrate the expected content and some key features for formatting contributions as well as reminding some of the guidelines:
251251

252252
::: {.grid}
253253

254254
::: {.g-col-4}
255255
::: {.callout-note icon="false"}
256-
## R
256+
### R
257257

258258
[![](/assets/img/computo-template-r.png)](https://computo-journal.org/template-computo-R/)
259259

@@ -263,7 +263,7 @@ Authors can find example papers for each language that illustrate the expected c
263263

264264
::: {.g-col-4}
265265
::: {.callout-tip icon="false"}
266-
## Python
266+
### Python
267267

268268
[![](/assets/img/computo-template-python.png)](https://computo-journal.org/template-computo-python/)
269269

@@ -273,7 +273,7 @@ Authors can find example papers for each language that illustrate the expected c
273273

274274
::: {.g-col-4}
275275
::: {.callout-important icon="false"}
276-
## Julia
276+
### Julia
277277

278278
[![](/assets/img/computo-template-julia.png)](https://computo-journal.org/template-computo-julia/)
279279

@@ -331,7 +331,7 @@ quarto add computorg/computo-quarto-extension
331331
quarto render .
332332
```
333333

334-
## Computo's code of ethics
334+
## Computo's code of ethics {#sec-ethics}
335335

336336
Originality
337337

0 commit comments

Comments
 (0)