Benchmarking

.github/workflows/asv-benchmarks.yml

@@ -0,0 +1,48 @@
+name: ASV Benchmarks
+
+on:
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: asv
+          python-version: "3.12"
+          channels: conda-forge
+          auto-activate-base: false
+
+      - name: Install ASV
+        shell: bash -l {0}
+        run: |
+          conda install -y -c conda-forge asv
+
+      - name: Configure ASV machine
+        shell: bash -l {0}
+        run: |
+          asv machine --yes
+
+      - name: Run ASV benchmarks
+        shell: bash -l {0}
+        run: |
+          asv run
+
+      - name: Publish ASV report
+        shell: bash -l {0}
+        run: |
+          asv publish
+
+      - name: Upload ASV results
+        uses: actions/upload-artifact@v4
+        with:
+          name: asv-results
+          path: |
+            .asv/results/
+            .asv/html/

.gitignore

@@ -41,6 +41,8 @@ htmlcov/
 .coverage
 .coverage.*
 .cache
+.asv/*
+.asv-openmp/*
 nosetests.xml
 coverage.xml
 *.cover

asv.conf.json

@@ -0,0 +1,30 @@
+{
+  "version": 1,
+  "project": "GSTools",
+  "project_url": "https://github.com/jeilealr/GSTools",
+  "repo": ".",
+  "branches": ["main"],
+  "benchmark_dir": "benchmarks",
+  "env_dir": ".asv/env",
+  "results_dir": ".asv/results",
+  "html_dir": ".asv/html",
+  "show_commit_url": "https://github.com/jeilealr/GSTools/commit/",
+  "environment_type": "conda",
+  "conda_channels": ["conda-forge"],
+  "pythons": ["3.12"],
+  "matrix": {
+    "req": {
+      "emcee": [""],
+      "hankel": [""],
+      "meshio": [""],
+      "numpy": [""],
+      "pyevtk": [""],
+      "scipy": [""],
+      "gstools-cython": [""]
+    }
+  },
+  "install_command": [
+    "in-dir={env_dir} python -m pip install gstools_core>=1.0.0",
+    "in-dir={env_dir} python -m pip install --no-deps {build_dir}"
+  ]
+}

asv.macos-openmp.conf.json

@@ -0,0 +1,36 @@
+{
+  "version": 1,
+  "project": "GSTools",
+  "project_url": "https://github.com/jeilealr/GSTools",
+  "repo": ".",
+  "branches": ["main"],
+  "benchmark_dir": "benchmarks",
+  "env_dir": ".asv-openmp/env",
+  "results_dir": ".asv-openmp/results",
+  "html_dir": ".asv-openmp/html",
+  "show_commit_url": "https://github.com/jeilealr/GSTools/commit/",
+  "environment_type": "conda",
+  "conda_channels": ["conda-forge"],
+  "pythons": ["3.12"],
+  "matrix": {
+    "req": {
+      "cython": [""],
+      "emcee": [""],
+      "extension-helpers": [""],
+      "hankel": [""],
+      "llvm-openmp": [""],
+      "meshio": [""],
+      "numpy": [""],
+      "pyevtk": [""],
+      "scipy": [""],
+      "setuptools": [""],
+      "wheel": [""]
+    }
+  },
+  "install_command": [
+    "in-dir={env_dir} python -m pip install gstools_core>=1.0.0",
+    "in-dir={env_dir} python {conf_dir}/benchmarks/tools/install_macos_openmp_cython.py {env_dir}",
+    "in-dir={env_dir} python {conf_dir}/benchmarks/tools/check_cython_openmp.py --fail-if-no-openmp",
+    "in-dir={env_dir} python -m pip install --no-deps {build_dir}"
+  ]
+}