Skip to content

Commit 8e7eef3

Browse files
authored
Rerun tutorials with SimPEG v0.22 (#24)
Bump simpeg version in `environment.yml` to v0.22 and rerun all notebooks with SimPEG v0.22. Replace `SimPEG` for the new `simpeg` throughout notebooks and Markdown files. Add admonitions mentioning the ability to run the potential field simulations using Choclo. Fix typo in `declination` argument for magnetics' `UniformBackgroundField`. Minor improvement in instruction to run all notebooks in `README.md`.
1 parent 1640750 commit 8e7eef3

32 files changed

+4606
-4348
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To rerun all notebooks, use:
104104
> filename expansion.
105105
106106
```bash
107-
jupyter nbconvert --to notebook --execute --inplace **/*.ipynb
107+
jupyter nbconvert --to notebook --execute --inplace notebooks/**/*.ipynb
108108
```
109109

110110

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ dependencies:
99
# Notebook requirements
1010
- jupyter
1111
- nbconvert
12-
- SimPEG==0.21.*
12+
- simpeg==0.22.*
1313
- discretize==0.10.*
1414
- pymatsolver

index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SimPEG user tutorials is the place for those who have [installed SimPEG](https:/
1010

1111

1212
:::{caution} Caution
13-
These user tutorials are meant to be run with SimPEG v0.21. Please, make sure
13+
These user tutorials are meant to be run with SimPEG v0.22. Please, make sure
1414
you have this version installed.
1515
:::
1616

@@ -42,9 +42,9 @@ SimPEG user tutorials provide a learning resource beyond a simple set of reprodu
4242

4343
**2. Creating objects in SimPEG:** A multitude of required and optional input arguments are set when creating objects within SimPEG. The proper syntax for setting input arguments is provided. The user will also learn the order in which objects are generally created for standard forward modeling and inversion.
4444

45-
```
45+
```python
4646
# Defining a receiver that measures total magnetic intensity data at (100, 0, 100).
47-
import SimPEG.potential_fields.magnetics as mag
47+
import simpeg.potential_fields.magnetics as mag
4848
my_receiver = mag.receivers.Point(np.c_[10., 0., 0.], components="tmi")
4949
```
5050

myst.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ project:
2727
scipy: https://docs.scipy.org/doc/scipy/
2828
matplotlib: https://matplotlib.org/stable/
2929
discretize: https://discretize.simpeg.xyz/en/main/
30-
SimPEG: https://docs.simpeg.xyz/
30+
simpeg: https://docs.simpeg.xyz/
3131
geoana: https://geoana.simpeg.xyz/
3232
sphinx: https://www.sphinx-doc.org/en/master/
3333
exclude:

notebooks/03-gravity/fwd_gravity_anomaly_3d.ipynb

Lines changed: 113 additions & 103 deletions
Large diffs are not rendered by default.

notebooks/03-gravity/fwd_gravity_gradiometry_3d.ipynb

Lines changed: 113 additions & 103 deletions
Large diffs are not rendered by default.

notebooks/03-gravity/inv_gravity_anomaly_3d.ipynb

Lines changed: 266 additions & 245 deletions
Large diffs are not rendered by default.

notebooks/04-magnetics/fwd_magnetics_induced_3d.ipynb

Lines changed: 108 additions & 105 deletions
Large diffs are not rendered by default.

notebooks/04-magnetics/fwd_magnetics_mvi_3d.ipynb

Lines changed: 110 additions & 101 deletions
Large diffs are not rendered by default.

notebooks/04-magnetics/inv_magnetics_induced_3d.ipynb

Lines changed: 261 additions & 248 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)