Skip to content

Commit 8ac60f6

Browse files
committed
add FAQ
1 parent 018f738 commit 8ac60f6

4 files changed

Lines changed: 9 additions & 5 deletions

File tree

.github/workflows/publish.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ jobs:
4545
pip install git+https://github.com/devitocodes/devito.git
4646
git clone https://github.com/devitocodes/devito.git
4747
cp -r devito/examples examples
48+
cp devito/FAQ.md FAQ.qmd
49+
# Remove back to top as integrated in all pages of the website
50+
sed -i '/^\[top/d' FAQ.qmd
4851
pip install git+https://github.com/machow/quartodoc.git
4952
quartodoc build
5053

_quarto.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ project:
22
type: website
33

44
website:
5-
title: "Devito"
5+
title: ""
66
image: images/logo.png
77
repo-url: https://github.com/devitocodes/devitocodes.github.io
88
repo-actions: [issue]
@@ -61,6 +61,8 @@ website:
6161
text: Tutorials
6262
- text: "API Reference"
6363
href: api/
64+
- text: "FAQ"
65+
href: FAQ.qmd
6466
- file: publications.qmd
6567
text: "Publications"
6668
- file: citing.qmd

download.qmd

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Download and Install Devito
3-
43
---
54

65
There are two main approaches to installing Devito.

index.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Symbolic computation is a powerful tool that allows users to:
3131
Devito is primarily designed to create wave propagation kernels for
3232
use in seismic inversion problems. A tutorial for the generation of a
3333
modelling operator using an acoustic wave equation can be found
34-
[here](https://nbviewer.jupyter.org/github/devitocodes/devito/blob/master/examples/seismic/tutorials/01_modelling.ipynb) and a paper
35-
outlining the verification procedures of the acoustic operator can be
36-
found [here](https://arxiv.org/abs/1608.08658).
34+
[here](https://nbviewer.jupyter.org/github/devitocodes/devito/blob/master/examples/seismic/tutorials/01_modelling.ipynb). A paper
35+
outlining the symbolic API and the verification procedures of the acoustic operator can be
36+
found [here](https://www.geosci-model-dev.net/12/1165/2019/) [@devito-api] and the internals of the compiler are described in [this paper](https://doi.org/10.1145/3374916) [@devito-compiler].
3737

3838

3939
### Key Features

0 commit comments

Comments
 (0)