Skip to content

Add MyST yml header to each notebook #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
santisoler merged 4 commits into from
Nov 19, 2024
Merged

Add MyST yml header to each notebook #27

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b80bcdc
Add details to authors in myst.yml
santisoler Oct 4, 2024
d9d4a95
Add jupyterlab-myst to environment.yml
santisoler Oct 4, 2024
4e847b7
Set title and authors of notebooks in myst header
santisoler Oct 4, 2024
8d718ce
Merge branch 'main' into yml-header-authors
santisoler Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ dependencies:
- mystmd
# Notebook requirements
- jupyter
- jupyterlab-myst
- nbconvert
- simpeg==0.22.*
- discretize==0.10.*
Expand Down
36 changes: 32 additions & 4 deletions myst.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,39 @@ project:
- open-source
authors:
- name: Devin Cowan
affiliations:
- University of British Columbia
id: devincowan
affiliations: ubc
roles:
- writing
- editing
- Software
Comment on lines +18 to +23
Copy link
Member Author

@santisoler santisoler Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dccowan, do you have an ORCID number you might want to include here?

- name: Lindsey Heagy
id: lindseyheagy
affiliations: ubc
orcid: 0000-0002-1551-5926
roles:
- Supervision
- Administration
- Software
- name: Santiago Soler
affiliations:
- University of British Columbia
id: santisoler
affiliations: ubc
orcid: 0000-0001-9202-5317
roles:
- editing
- Software
affiliations:
- id: ubc
institution: University of British Columbia
ror: https://ror.org/03rmrcq20
isni: 0000 0001 2288 9830
department: Department of Earth, Ocean and Atmospheric Sciences
address: 2020 – 2207 Main Mall
city: Vancouver
region: British Columbia
country: Canada
postal_code: V6T 1Z4
phone: 604 822 2449
# bibliography: []
references:
python: https://docs.python.org/3/
Expand Down
10 changes: 5 additions & 5 deletions notebooks/03-gravity/fwd_gravity_anomaly_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Forward Simulation of Gravity Anomaly Data"
"---\n",
"title: \"3D Forward Simulation of Gravity Anomaly Data\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** gravity survey, gravity anomaly, forward simulation, integral formulation, tensor mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/03-gravity/fwd_gravity_gradiometry_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Forward Simulation of Gravity Gradiometry Data"
"---\n",
"title: \"3D Forward Simulation of Gravity Gradiometry Data\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** gravity anomaly, forward simulation, integral formulation, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Inversion of Gravity Anomaly Data"
"---\n",
"title: \"3D Inversion of Gravity Anomaly Data\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** gravity anomaly, integral formulation, inversion, sparse norm, tensor mesh, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/04-magnetics/fwd_magnetics_induced_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Forward Simulation of TMI Data"
"---\n",
"title: \"3D Forward Simulation of TMI Data\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** total magnetic intensity, forward simulation, integral formulation, tensor mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/04-magnetics/fwd_magnetics_mvi_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Forward Simulation of Magnetic Gradiometry Data for Magnetic Vector Models"
"---\n",
"title: \"3D Forward Simulation of Magnetic Gradiometry Data for Magnetic Vector Models\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** gradiometry, magnetic vector model, forward simulation, integral formulation, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/04-magnetics/inv_magnetics_induced_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Inversion of TMI Data to Recover a Susceptibility Model"
"---\n",
"title: \"3D Inversion of TMI Data to Recover a Susceptibility Model\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** total magnetic intensity, integral formulation, inversion, sparse norm, tensor mesh, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/fwd_dcr_1d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 1D Forward Simulation for a Single Sounding"
"---\n",
"title: \"1D Forward Simulation for a Single Sounding\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC resistivity, forward simulation, apparent resistivity, 1D sounding, wires mapping.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/fwd_dcr_2d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 2.5D Forward Simulation"
"---\n",
"title: \"2.5D Forward Simulation\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC resistivity, forward simulation, 2.5D, apparent resistivity, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/fwd_dcr_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D Forward Simulation"
"---\n",
"title: \"3D Forward Simulation\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC Resistivity, forward simulation, 3D, apparent resistivity, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/inv_dcr_1d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 1D Inversion for a Single Sounding"
"---\n",
"title: \"1D Inversion for a Single Sounding\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC resistivity, 1D sounding, inversion, parametric, sparse norm, apparent resistivity, wires mapping.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/inv_dcr_2d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 2.5D DC Resistivity Inversion"
"---\n",
"title: \"2.5D DC Resistivity Inversion\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC resistivity, 2.5D inversion, sparse norm, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/05-dcr/inv_dcr_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D DC Resistivity Inversion"
"---\n",
"title: \"3D DC Resistivity Inversion\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** DC resistivity, 3D inversion, weighted least-squares, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/06-ip/fwd_ip_2d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 2.5D IP Forward Simulation"
"---\n",
"title: \"2.5D IP Forward Simulation\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** Induced polarization, 2.5D forward simulation, apparent chargeability, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
10 changes: 5 additions & 5 deletions notebooks/06-ip/fwd_ip_3d.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# 3D IP Forward Simulation"
"---\n",
"title: \"3D IP Forward Simulation\"\n",
"authors:\n",
" - id: devincowan\n",
"---"
]
},
{
Expand All @@ -31,10 +35,6 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"**Author:** Devin C. Cowan\n",
"\n",
"</br>\n",
"\n",
"**Keywords:** Induced polarization, 3D forward simulation, apparent chargeability, tree mesh.\n",
"\n",
"</br>\n",
Expand Down
Loading