Skip to content

Commit 4febfcf

Browse files
authored
Add MyST yml header to each notebook (#27)
Add a yml header to the first cell of notebooks including title and authors. Improve list of authors in `myst.yml`. Add Lindsey to the list of authors. Add UBC as an affiliation with id so we can reuse it on each author. Add ORCIDs. Add jupyterlab-myst to environment.yml to render those cells in Jupyter Lab. Fixes #26
1 parent 7429b30 commit 4febfcf

30 files changed

+209
-144
lines changed

environment.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ dependencies:
88
- mystmd
99
# Notebook requirements
1010
- jupyter
11+
- jupyterlab-myst
1112
- nbconvert
1213
- simpeg==0.22.*
1314
- discretize==0.10.*

myst.yml

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,39 @@ project:
1515
- open-source
1616
authors:
1717
- name: Devin Cowan
18-
affiliations:
19-
- University of British Columbia
18+
id: devincowan
19+
affiliations: ubc
20+
roles:
21+
- writing
22+
- editing
23+
- Software
24+
- name: Lindsey Heagy
25+
id: lindseyheagy
26+
affiliations: ubc
27+
orcid: 0000-0002-1551-5926
28+
roles:
29+
- Supervision
30+
- Administration
31+
- Software
2032
- name: Santiago Soler
21-
affiliations:
22-
- University of British Columbia
33+
id: santisoler
34+
affiliations: ubc
35+
orcid: 0000-0001-9202-5317
36+
roles:
37+
- editing
38+
- Software
39+
affiliations:
40+
- id: ubc
41+
institution: University of British Columbia
42+
ror: https://ror.org/03rmrcq20
43+
isni: 0000 0001 2288 9830
44+
department: Department of Earth, Ocean and Atmospheric Sciences
45+
address: 2020 – 2207 Main Mall
46+
city: Vancouver
47+
region: British Columbia
48+
country: Canada
49+
postal_code: V6T 1Z4
50+
phone: 604 822 2449
2351
# bibliography: []
2452
references:
2553
python: https://docs.python.org/3/

notebooks/03-gravity/fwd_gravity_anomaly_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Forward Simulation of Gravity Anomaly Data"
7+
"---\n",
8+
"title: \"3D Forward Simulation of Gravity Anomaly Data\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** gravity survey, gravity anomaly, forward simulation, integral formulation, tensor mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/03-gravity/fwd_gravity_gradiometry_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Forward Simulation of Gravity Gradiometry Data"
7+
"---\n",
8+
"title: \"3D Forward Simulation of Gravity Gradiometry Data\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** gravity anomaly, forward simulation, integral formulation, tree mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Inversion of Gravity Anomaly Data"
7+
"---\n",
8+
"title: \"3D Inversion of Gravity Anomaly Data\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** gravity anomaly, integral formulation, inversion, sparse norm, tensor mesh, tree mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/04-magnetics/fwd_magnetics_induced_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Forward Simulation of TMI Data"
7+
"---\n",
8+
"title: \"3D Forward Simulation of TMI Data\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** total magnetic intensity, forward simulation, integral formulation, tensor mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/04-magnetics/fwd_magnetics_mvi_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Forward Simulation of Magnetic Gradiometry Data for Magnetic Vector Models"
7+
"---\n",
8+
"title: \"3D Forward Simulation of Magnetic Gradiometry Data for Magnetic Vector Models\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** gradiometry, magnetic vector model, forward simulation, integral formulation, tree mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/04-magnetics/inv_magnetics_induced_3d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 3D Inversion of TMI Data to Recover a Susceptibility Model"
7+
"---\n",
8+
"title: \"3D Inversion of TMI Data to Recover a Susceptibility Model\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** total magnetic intensity, integral formulation, inversion, sparse norm, tensor mesh, tree mesh.\n",
3939
"\n",
4040
"</br>\n",

notebooks/05-dcr/fwd_dcr_1d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 1D Forward Simulation for a Single Sounding"
7+
"---\n",
8+
"title: \"1D Forward Simulation for a Single Sounding\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** DC resistivity, forward simulation, apparent resistivity, 1D sounding, wires mapping.\n",
3939
"\n",
4040
"</br>\n",

notebooks/05-dcr/fwd_dcr_2d.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# 2.5D Forward Simulation"
7+
"---\n",
8+
"title: \"2.5D Forward Simulation\"\n",
9+
"authors:\n",
10+
" - id: devincowan\n",
11+
"---"
812
]
913
},
1014
{
@@ -31,10 +35,6 @@
3135
"cell_type": "markdown",
3236
"metadata": {},
3337
"source": [
34-
"**Author:** Devin C. Cowan\n",
35-
"\n",
36-
"</br>\n",
37-
"\n",
3838
"**Keywords:** DC resistivity, forward simulation, 2.5D, apparent resistivity, tree mesh.\n",
3939
"\n",
4040
"</br>\n",

0 commit comments

Comments
 (0)