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
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ page-layout: article
11
11
bibliography: ../publications/published.bib
12
12
---
13
13
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}
15
15
16
16
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/)).
17
17
@@ -23,7 +23,7 @@ A Computo submission is thus a Git(Hub) repository containing:
23
23
24
24
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.
25
25
26
-
### Setup a git repository
26
+
### Setup a git repository {#sec-git}
27
27
28
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
@@ -45,7 +45,7 @@ In summary, before clicking on *Create repository*, you should have the options
45
45
You can use Gitlab for submitting to Computo. We will be giving more detailed support for this in the future.
46
46
:::
47
47
48
-
### Setup Quarto and Computo extension on your system
48
+
### Setup Quarto and Computo extension on your system {#sec-quarto}
49
49
50
50
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.
51
51
@@ -66,7 +66,7 @@ If you are collaborating with others when writing your contributions, **each col
66
66
- install the Computo Quarto extension by executing the above command.
67
67
:::
68
68
69
-
### Write your contribution
69
+
### Write your contribution {#sec-writing}
70
70
71
71
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`.
72
72
@@ -132,7 +132,7 @@ format:
132
132
133
133
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.
134
134
135
-
### Setup dependencies
135
+
### Setup dependencies {#sec-dependencies}
136
136
137
137
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.
138
138
@@ -154,7 +154,7 @@ The next step is to inform Computo of the other packages, tools and environment
154
154
{{< include _handle_dependencies_julia.qmd >}}
155
155
:::
156
156
157
-
### Ensure reproducibility
157
+
### Ensure reproducibility {#sec-reproducibility}
158
158
159
159
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.
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.
227
227
@@ -231,7 +231,7 @@ The PDF version should then be submitted to the [OpenReview](https://openreview.
231
231
232
232
You can find more details about the scientific reviewing process in the [dedicated page](/site/guidelines-reviewers.qmd) on this website (*Reviewers* tabs).
233
233
234
-
### Accepted manuscript
234
+
### Accepted manuscript {#sec-acceptance}
235
235
236
236
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.
237
237
@@ -245,15 +245,15 @@ A new page opens where you need to select *Specify an organization or username*
245
245
246
246
{#fig-transfer-ownership-3 width="100%" fig-align="center"}
247
247
248
-
## Example papers
248
+
## Example papers {#sec-examples}
249
249
250
250
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:
0 commit comments