MiraGeoscience · sebhmg · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025
diff --git a/.ci/azure/docs.yml b/.ci/azure/docs.yml
@@ -5,7 +5,7 @@ jobs:
     pool:
       vmImage: ubuntu-latest
     variables:
-      python.version: "3.10"
+      python.version: "3.11"
     timeoutInMinutes: 240
     steps:
       # Checkout simpeg repo.

diff --git a/.ci/azure/pypi.yml b/.ci/azure/pypi.yml
@@ -12,7 +12,7 @@ jobs:
 
       - task: UsePythonVersion@0
         inputs:
-          versionSpec: "3.10"
+          versionSpec: "3.11"
         displayName: "Setup Python"
 
       - bash: |
@@ -57,7 +57,7 @@ jobs:
 
       - task: UsePythonVersion@0
         inputs:
-          versionSpec: "3.10"
+          versionSpec: "3.11"
         displayName: "Setup Python"
 
       - bash: |

diff --git a/.ci/azure/setup_env.sh b/.ci/azure/setup_env.sh
@@ -2,10 +2,17 @@
 set -ex #echo on and exit if any line fails
 
 # TF_BUILD is set to True on azure pipelines.
-is_azure=$(${TF_BUILD:-false} | tr '[:upper:]' '[:lower:]')
+is_azure=$(echo "${TF_BUILD:-false}" | tr '[:upper:]' '[:lower:]')
 
 if ${is_azure}
 then
+  # Add conda-forge as channel
+  conda config --add channels conda-forge
+  # Remove defaults channels
+  # (both from ~/.condarc and from /usr/share/miniconda/.condarc)
+  conda config --remove channels defaults
+  conda config --remove channels defaults --system
+  # Update conda
   conda update --yes -n base conda
 fi
 
@@ -30,4 +37,4 @@ echo "Conda Environment:"
 conda list
 
 echo "Installed SimPEG version:"
-python -c "import simpeg; print(simpeg.__version__)"
+python -c "import simpeg; print(simpeg.__version__)"
diff --git a/.ci/azure/test.yml b/.ci/azure/test.yml
@@ -1,6 +1,6 @@
 parameters:
   os : ['ubuntu-latest']
-  py_vers: ['3.10']
+  py_vers: ['3.11']
   test: ['tests/em',
          'tests/base tests/flow tests/seis tests/utils',
          'tests/meta',

diff --git a/.ci/environment_test.yml b/.ci/environment_test.yml
@@ -3,12 +3,13 @@ channels:
   - conda-forge
 dependencies:
   - numpy>=1.22
-  - scipy>=1.8
+  - scipy>=1.12
   - pymatsolver>=0.3
   - matplotlib-base
-  - discretize>=0.11
-  - geoana>=0.7
+  - discretize>=0.12
+  - geoana>=0.8.1
   - libdlf
+  - typing_extensions
 
 # optional dependencies
   - dask
@@ -24,6 +25,8 @@ dependencies:
   - sphinx
   - sphinx-gallery>=0.1.13
   - sphinxcontrib-apidoc
+  - sphinx-reredirects
+  - sphinx-design
   - pydata-sphinx-theme
   - nbsphinx
   - numpydoc
@@ -43,4 +46,4 @@ dependencies:
 # PyPI uploading
   - wheel
   - twine
-  - build
+  - python-build
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,7 +1,7 @@
 name: Bug report
 description: Report a bug in SimPEG.
 title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
-labels: [Bug]
+labels: ["bug"]
 
 body:
 - type: markdown
@@ -46,6 +46,7 @@ body:
     description: >
       Please include the output from `simpeg.Report()` to describe your system for us.
       Paste the output from `from simpeg import Report; print(Report())` below.
+    render: shell
   validations:
     required: true
 

diff --git a/.github/workflows/issue_to_jira.yml b/.github/workflows/issue_to_jira.yml
@@ -9,7 +9,7 @@ permissions: {}
 jobs:
   call-workflow-create-jira-issue:
     if: startsWith(github.repository, 'MiraGeoscience/')  # run on the Mira repo only
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-jira-issue_to_jira.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-jira-issue_to_jira.yml@v3
     permissions:
       contents: read
       issues: write

diff --git a/.github/workflows/pr_add_jira_summary.yml → .github/workflows/pr_jira_actions.yml b/.github/workflows/pr_add_jira_summary.yml → .github/workflows/pr_jira_actions.yml
@@ -1,19 +1,17 @@
-name: Add JIRA issue summary
+name: JIRA actions
 
 on:
-  pull_request_target:  # zizmor: ignore[dangerous-triggers]
-    types: [opened]
-
-permissions: {}
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, edited]
 
 jobs:
-  call-workflow-add-jira-issue-summary:
-    if: startsWith(github.repository, 'MiraGeoscience/')  # run if PR targets the Mira repo only
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-jira-pr_add_jira_summary.yml@v2
+  call-workflow-pr_jira_actions:
+    if: github.event.action != 'edited' || github.event.changes.title != null
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-jira-pr_actions.yml@v3
     permissions:
       contents: read
       pull-requests: write
     secrets:
-      JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
-      JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
       JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+      JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
+      JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
diff --git a/.github/workflows/python_deploy_dev.yml b/.github/workflows/python_deploy_dev.yml
@@ -14,12 +14,12 @@ concurrency:
 jobs:
   call-workflow-conda-publish:
     name: Publish development conda package on JFrog Artifactory
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-publish_rattler_package.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-publish_rattler_package.yml@v3
     permissions:
       contents: write
     with:
       package-name: 'mira-simpeg'
-      python-version: '3.10'
+      python-version: '3.12'
       source-repo-names: '["public-noremote-conda-dev"]'
       conda-channels: '["conda-forge"]'
       publish-repo-names: '["public-noremote-conda-dev"]'
@@ -29,14 +29,14 @@ jobs:
       JFROG_ARTIFACTORY_TOKEN: ${{ secrets.JFROG_ARTIFACTORY_TOKEN }}
   call-workflow-pypi-publish:
     name: Publish development pypi package (JFrog Artifactory, TestPyPI)
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-publish_pypi_package.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-publish_pypi_package.yml@v3
     permissions:
       contents: write
     with:
       package-manager: 'setuptools'
       package-name: 'mira-simpeg'
       version-tag: ${{ github.ref_name }}
-      python-version: '3.10'
+      python-version: '3.12'
       virtual-repo-names: '["public-pypi-dev", "test-pypi"]'
     secrets:
       JFROG_ARTIFACTORY_URL: ${{ secrets.JFROG_ARTIFACTORY_URL }}

diff --git a/.github/workflows/python_deploy_prod.yml b/.github/workflows/python_deploy_prod.yml
@@ -29,7 +29,7 @@ jobs:
   call-workflow-conda-release:
     name: Publish production Conda package on JFrog Artifactory
     if: ${{ github.event_name == 'release' || github.event.inputs.publish-conda == 'true' }}
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-release_conda_assets.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-release_conda_assets.yml@v3
     permissions:
       contents: write
     with:
@@ -41,7 +41,7 @@ jobs:
   call-workflow-pypi-release:
     name: Publish production PyPI package (JFrog Artifactory, PyPI)
     if: ${{ github.event_name == 'release' || github.event.inputs.publish-pypi == 'true' }}
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-release_pypi_assets.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-release_pypi_assets.yml@v3
     permissions:
       contents: write
     with:

diff --git a/.github/workflows/security_scan.yml b/.github/workflows/security_scan.yml
@@ -32,7 +32,7 @@ jobs:
       security-events: write
       contents: read
       actions: read
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-zizmor-advanced-security.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-zizmor-advanced-security.yml@v3
 
   call-workflow-zizmor-advanced-security:
     name: Zizmor analysis (annotate)
@@ -42,4 +42,4 @@ jobs:
       checks: write
       contents: read
       actions: read
-    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-zizmor-annotate.yml@v2
+    uses: MiraGeoscience/CI-tools/.github/workflows/reusable-zizmor-annotate.yml@v3
diff --git a/.gitignore b/.gitignore
@@ -47,8 +47,8 @@ docs/_build/
 docs/warnings.txt
 docs/content/api/generated/*
 .DS_Store
-docs/content/examples/*
-docs/content/tutorials/*
+docs/content/user-guide/examples/*
+docs/content/user-guide/tutorials/*
 docs/modules/*
 docs/sg_execution_times.rst
 .vscode/*

diff --git a/CITATION.rst b/CITATION.rst
@@ -1,13 +1,17 @@
+=============
 Citing SimPEG
--------------
+=============
 
-There is a `paper about SimPEG <http://dx.doi.org/10.1016/j.cageo.2015.09.015>`_, if you use this code, please help our scientific visibility by citing our work!
+There is a paper about SimPEG! If you are using this library in your research,
+we greatly appreciate that the software gets cited!
 
 
-    Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W. (2015). SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications. Computers & Geosciences.
+    Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W.
+    (2015). SimPEG: An open source framework for simulation and gradient based
+    parameter estimation in geophysical applications. Computers & Geosciences.
 
 
-BibTex:
+Here is a Bibtex entry to make things easier if you’re using Latex:
 
 .. code::
 
@@ -19,3 +23,24 @@ BibTex:
       publisher={Elsevier}
     }
 
+Electromagnetics
+----------------
+
+If you are using the :mod:`simpeg.electromagnetics` module, please also cite:
+
+    Lindsey J. Heagy, Rowan Cockett, Seogi Kang, Gudni K. Rosenkjaer, Douglas W. Oldenburg, A framework for simulation and inversion in electromagnetics, Computers & Geosciences, Volume 107, 2017, Pages 1-19, ISSN 0098-3004, http://dx.doi.org/10.1016/j.cageo.2017.06.018.
+
+Here is a Bibtex entry to make things easier if you’re using Latex:
+
+.. code::
+
+    @article{heagy2017,
+      title={A framework for simulation and inversion in electromagnetics},
+      author={Lindsey J. Heagy and Rowan Cockett and Seogi Kang and Gudni K. Rosenkjaer and Douglas W. Oldenburg},
+      journal={Computers & Geosciences},
+      volume={107},
+      pages={1 - 19},
+      year={2017},
+      issn={0098-3004},
+      doi={http://dx.doi.org/10.1016/j.cageo.2017.06.018}
+    }
diff --git a/README.rst b/README.rst
@@ -48,7 +48,7 @@ The vision is to create a package for finite volume simulation with applications
 
 You are welcome to join our forum and engage with people who use and develop SimPEG at: https://simpeg.discourse.group/.
 
-Weekly meetings are open to all. They are generally held on Wednesdays at 10:30am PDT. Please see the calendar (`GCAL <https://calendar.google.com/calendar/b/0?cid=ZHVhamYzMWlibThycWdkZXM5NTdoYXV2MnNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`_, `ICAL <https://calendar.google.com/calendar/ical/duajf31ibm8rqgdes957hauv2s%40group.calendar.google.com/public/basic.ics>`_) for information on the next meeting.
+Weekly meetings are open to all. They are generally held on Wednesdays at 3:00 PM Pacific Time. Please see the calendar (`GCAL <https://calendar.google.com/calendar/b/0?cid=ZHVhamYzMWlibThycWdkZXM5NTdoYXV2MnNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`_, `ICAL <https://calendar.google.com/calendar/ical/duajf31ibm8rqgdes957hauv2s%40group.calendar.google.com/public/basic.ics>`_) for information on the next meeting.
 
 Overview Video
 ==============
@@ -120,9 +120,8 @@ Meetings
 SimPEG hosts weekly meetings for users to interact with each other,
 for developers to discuss upcoming changes to the code base, and for
 discussing topics related to geophysics in general.
-Currently our meetings are held every Wednesday, alternating between
-a mornings (10:30 am pacific time) and afternoons (3:00 pm pacific time)
-on even numbered Wednesdays. Find more info on our
+Currently our meetings are held every Wednesday at 3:00 PM Pacific Time.
+Find more info on our
 `Mattermost <https://mattermost.softwareunderground.org/simpeg>`_.
 
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -43,8 +43,8 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf content/api/generated/
-	rm -rf content/examples/
-	rm -rf content/tutorials/
+	rm -rf content/user-guide/examples/
+	rm -rf content/user-guide/tutorials/
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html -j auto

diff --git a/docs/_static/versions.json b/docs/_static/versions.json
@@ -4,11 +4,21 @@
         "url": "https://docs.simpeg.xyz/dev/"
     },
     {
-        "name": "v0.23.0 (latest)",
-        "version": "0.23.0",
-        "url": "https://docs.simpeg.xyz/v0.23.0/",
+        "name": "v0.25.0 (latest)",
+        "version": "0.25.0",
+        "url": "https://docs.simpeg.xyz/v0.25.0/",
         "preferred": true
     },
+    {
+        "name": "v0.24.0",
+        "version": "0.24.0",
+        "url": "https://docs.simpeg.xyz/v0.24.0/"
+    },
+    {
+        "name": "v0.23.0",
+        "version": "0.23.0",
+        "url": "https://docs.simpeg.xyz/v0.23.0/"
+    },
     {
         "name": "v0.22.2",
         "version": "0.22.2",