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: notebooks/contributing/formatting.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Every tutorial notebook requires an introduction section. The Markdown cells req
19
19
The first cell contains the title and the author for the tutorial. It is formatted as follows.
20
20
The title is in quotations. You will need to add yourself as an author in the `myst.yml` file in the root directory of the repository.
21
21
22
-
```
22
+
```yaml
23
23
---
24
24
title: "My Notebook Title In Quotes"
25
25
authors:
@@ -91,13 +91,13 @@ to a cluster computing environment.
91
91
92
92
In this cell, the contributor must provide a set of relevant keywords. E.g.
93
93
94
-
```
94
+
```markdown
95
95
**Keywords:** gravity inversion, sparse-norm inversion, integral formulation, tree mesh.
96
96
```
97
97
98
98
Next, the contributor must provide a summary of the tutorial. The summary should be roughly one paragraph. If your tutorial focusses on particular functionality within SimPEG, please link to the API documentation. Also, link to tutorials you feel the reader should have already worked through. E.g.
99
99
100
-
```
100
+
```markdown
101
101
**Summary:** Here we invert gravity anomaly data to recover a density contrast model.
102
102
We demonstrate two approaches for recovering a density contrast model:
103
103
@@ -115,7 +115,7 @@ Anomaly Data](fwd_gravity_anomaly_3d.ipynb) tutorial before working through this
115
115
116
116
Finally, the contributor must provide learning objectives using a bullet list. E.g.
117
117
118
-
```
118
+
```markdown
119
119
**Learning Objectives:**
120
120
121
121
- How geophysical inversion is carried out using SimPEG.
@@ -190,7 +190,7 @@ Here, the contributor must:
190
190
191
191
E.g.
192
192
193
-
```
193
+
```markdown
194
194
## Define the Survey
195
195
196
196
Surveys within SimPEG generally require the user to create and connect three
@@ -215,7 +215,7 @@ which are to be measured. For the tutorial simulation, the receivers are located
215
215
If something has been thoroughly explained in an introductory tutorial, you can avoid repetition by linking to that tutorial.
216
216
However, the choice in values used in your tutorial should always be stated. E.g.
217
217
218
-
```
218
+
```markdown
219
219
## Assign Uncertainties
220
220
221
221
Approaches for applying reasonable uncertainties to normalized voltage and apparent
0 commit comments