Update to latest (0.25.0+)

.ci/azure/codecov.yml

@@ -0,0 +1,36 @@
+jobs:
+  - job:
+    pool:
+      vmImage: "ubuntu-latest"
+    displayName: Upload to Codecov
+    steps:
+      # Checkout simpeg repo. Codecov needs the repo in the file system for
+      # uploading coverage reports.
+      - checkout: self
+        displayName: "Checkout repository"
+
+      - task: DownloadPipelineArtifact@2
+        inputs:
+          patterns: "coverage-*/coverage-*.xml"
+        displayName: "Download coverage artifacts"
+
+      - bash: ls -la $(Pipeline.Workspace)/coverage-*/coverage-*.xml
+        displayName: "List downloaded coverage artifacts"
+
+      - bash: |
+          cp $(Pipeline.Workspace)/coverage-*/coverage-*.xml .
+          ls -la
+        displayName: "Copy coverage files"
+
+      - bash: |
+          curl -Os https://uploader.codecov.io/latest/linux/codecov
+          chmod +x codecov
+        displayName: "Install codecov cli"
+
+      - bash: |
+          cc_file_args=()
+          for report in coverage-*.xml; do
+              cc_file_args+=( " --file " "$report" )
+          done
+          ./codecov --verbose upload-process "$cc_file_args"
+        displayName: "Upload coverage to codecov.io"

.ci/azure/deploy-dev-docs.sh

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+# Push built docs to dev branch in simpeg-docs repository
+
+set -ex #echo on and exit if any line fails
+
+# ---------------------------
+# Push new docs to dev branch
+# ---------------------------
+# Capture hash of last commit in simpeg
+commit=$(git rev-parse --short HEAD)
+
+# Clone the repo where we store the documentation (dev branch)
+git clone -q --branch dev --depth 1 "https://${GH_TOKEN}@github.com/simpeg/simpeg-docs.git"
+cd simpeg-docs
+
+# Remove all files (but .git folder)
+find . -not -path "./.git/*" -not -path "./.git" -delete
+
+# Copy the built docs to the root of the repo
+cp -r "$BUILD_SOURCESDIRECTORY"/docs/_build/html/. -t .
+
+# Add new files
+git add .
+
+# List files in working directory and show git status
+ls -la
+git status
+
+# Commit the new docs. Amend to avoid having a very large history.
+message="Azure CI deploy dev from ${commit}"
+echo -e "\nAmending last commit:"
+git commit --amend --reset-author -m "$message"
+
+# Make the push quiet just in case there is anything that could
+# leak sensitive information.
+echo -e "\nPushing changes to simpeg/simpeg-docs (dev branch)."
+git push -fq origin dev 2>&1 >/dev/null
+echo -e "\nFinished uploading doc files."
+
+# ----------------
+# Update submodule
+# ----------------
+# Need to fetch the gh-pages branch first (because we clone with shallow depth)
+git fetch --depth 1 origin gh-pages:gh-pages
+
+# Switch to the gh-pages branch
+git switch gh-pages
+
+# Update the dev submodule
+git submodule update --init --recursive --remote dev
+
+# Add updated submodule
+git add dev
+
+# List files in working directory and show git status
+ls -la
+git status
+
+# Commit changes
+message="Azure CI update dev submodule from ${commit}"
+echo -e "\nMaking a new commit:"
+git commit -m "$message"
+
+# Make the push quiet just in case there is anything that could
+# leak sensitive information.
+echo -e "\nPushing changes to simpeg/simpeg-docs (gh-pages branch)."
+git push -q origin gh-pages 2>&1 >/dev/null
+echo -e "\nFinished updating submodule dev."

.ci/azure/deploy-release-docs.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# Push built docs to gh-pages branch in simpeg-docs repository
+
+set -ex #echo on and exit if any line fails
+
+# Capture simpeg version
+version=$(git tag --points-at HEAD)
+if [[ -z $version ]]; then
+echo "Version could not be obtained from tag. Exiting."
+exit 1
+fi
+
+# Capture hash of last commit in simpeg
+commit=$(git rev-parse --short HEAD)
+
+# Clone the repo where we store the documentation
+git clone -q --branch gh-pages --depth 1 "https://${GH_TOKEN}@github.com/simpeg/simpeg-docs.git"
+cd simpeg-docs
+
+# Move the built docs to a new dev folder
+cp -r "$BUILD_SOURCESDIRECTORY/docs/_build/html" "$version"
+cp "$BUILD_SOURCESDIRECTORY/docs/README.md" .
+
+# Add .nojekyll if missing
+touch .nojekyll
+
+# Update latest symlink
+rm -f latest
+ln -s "$version" latest
+
+# Add new docs and relevant files
+git add "$version" README.md .nojekyll latest
+
+# List files in working directory and show git status
+ls -la
+git status
+
+# Commit the new docs.
+message="Azure CI deploy ${version} from ${commit}"
+echo -e "\nMaking a new commit:"
+git commit -m "$message"
+
+# Make the push quiet just in case there is anything that could
+# leak sensitive information.
+echo -e "\nPushing changes to simpeg/simpeg-docs."
+git push -fq origin gh-pages 2>&1 >/dev/null
+echo -e "\nFinished uploading generated files."

.ci/azure/docs.yml

@@ -0,0 +1,112 @@
+jobs:
+  # Build docs only on scheduled jobs or on a relase
+  - job: BuildDocs
+    condition: or(eq(variables['Build.Reason'], 'Schedule'), startsWith(variables['build.sourceBranch'], 'refs/tags/'))
+    pool:
+      vmImage: ubuntu-latest
+    variables:
+      python.version: "3.11"
+    timeoutInMinutes: 240
+    steps:
+      # Checkout simpeg repo.
+      # Sync tags and disable shallow depth to get the SimPEG version.
+      - checkout: self
+        fetchDepth: 0
+        fetchTags: true
+        displayName: Checkout repository (including tags)
+
+      - bash: echo "##vso[task.prependpath]$CONDA/bin"
+        displayName: Add conda to PATH
+
+      - bash: .ci/azure/setup_env.sh
+        displayName: Setup SimPEG environment
+
+      - bash: |
+          source activate simpeg-test
+          make -C docs html
+        displayName: Building documentation
+
+      - task: PublishPipelineArtifact@1
+        inputs:
+          targetPath: $(Build.SourcesDirectory)/docs/_build/html
+          artifactName: built-docs
+        displayName: "Upload docs as artifact"
+
+  - job: DeployRelease
+    dependsOn: BuildDocs
+    condition: startsWith(variables['build.sourceBranch'], 'refs/tags/')
+    pool:
+      vmImage: ubuntu-latest
+    timeoutInMinutes: 240
+    steps:
+      # Checkout simpeg repo.
+      # Sync tags and disable shallow depth to get the SimPEG version.
+      - checkout: self
+        fetchDepth: 0
+        fetchTags: true
+        displayName: Checkout repository (including tags)
+
+      - bash: |
+          git config --global user.name ${GH_NAME}
+          git config --global user.email ${GH_EMAIL}
+          git config --list | grep user.
+        displayName: "Configure git"
+        env:
+          GH_NAME: $(gh.name)
+          GH_EMAIL: $(gh.email)
+
+      - bash: |
+          mkdir -p docs/_build/html
+        displayName: "Create directory for built docs"
+
+      - task: DownloadPipelineArtifact@2
+        inputs:
+          artifact: built-docs
+          targetPath: docs/_build/html
+        displayName: "Download docs artifact"
+
+      # Upload release build of the docs to gh-pages branch in simpeg/simpeg-docs
+      - bash: .ci/azure/deploy-release-docs.sh
+        displayName: Push documentation to simpeg-docs
+        env:
+          GH_TOKEN: $(gh.token)
+
+  - job: DeployDev
+    dependsOn: BuildDocs
+    condition: eq(variables['Build.Reason'], 'Schedule') # run only scheduled triggers
+    pool:
+      vmImage: ubuntu-latest
+    timeoutInMinutes: 240
+    steps:
+      # Checkout simpeg repo.
+      # Sync tags and disable shallow depth to get the SimPEG version.
+      - checkout: self
+        fetchDepth: 0
+        fetchTags: true
+        displayName: Checkout repository (including tags)
+
+      - bash: |
+          git config --global user.name ${GH_NAME}
+          git config --global user.email ${GH_EMAIL}
+          git config --list | grep user.
+        displayName: "Configure git"
+        env:
+          GH_NAME: $(gh.name)
+          GH_EMAIL: $(gh.email)
+
+      - bash: |
+          mkdir -p docs/_build/html
+        displayName: "Create directory for built docs"
+
+      - task: DownloadPipelineArtifact@2
+        inputs:
+          artifact: built-docs
+          targetPath: docs/_build/html
+        displayName: "Download docs artifact"
+
+      # Upload dev build of the docs to a dev branch in simpeg/simpeg-docs
+      # and update submodule in the gh-pages branch
+      - bash: .ci/azure/deploy-dev-docs.sh
+        displayName: Push documentation to simpeg-docs (dev branch)
+        env:
+          GH_TOKEN: $(gh.token)