.gitignore

@@ -49,6 +49,7 @@ nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
+/bench/
 
 # Translations
 *.mo

.gitlab-ci.yml

@@ -31,6 +31,15 @@ test:
     paths:
       - cov
 
+benchmark:
+  stage: test
+  script:
+    - pip3 install --editable .[test]
+    - python -m pytest -v benchmarks/ --benchmark-histogram bench/bench  --benchmark-sort name
+  artifacts:
+    paths:
+      - bench
+
 doctest:
   stage: test
   script:

benchmarks/README.md

+# FINAM benchmarks
+
+## Data
+
+### Tools
+
+![tools](https://git.ufz.de/FINAM/finam/-/jobs/artifacts/main/raw/bench/bench-data-tools.svg?job=benchmark)

benchmarks/data/test_tools.py

+import datetime as dt
+import unittest
+
+import pytest
+
+import finam as fm
+from finam.data import (
+    assign_time,
+    check,
+    full,
+    full_like,
+    get_magnitude,
+    get_time,
+    get_units,
+    has_time,
+    strip_data,
+    strip_time,
+    to_units,
+    to_xarray,
+)
+
+
+class TestCheckXarray(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_check_xarray_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(check, xdata=xdata, name="test", info=info, time=time)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_check_xarray_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(check, xdata=xdata, name="test", info=info, time=time)
+
+
+class TestToXarray(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_xarray_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        data = strip_data(xdata)
+        _result = self.benchmark(
+            to_xarray, data=data, name="test", info=info, time=time
+        )
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_xarray_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        xdata = full(0.0, "test", info, time)
+        data = strip_data(xdata)
+        _result = self.benchmark(
+            to_xarray, data=data, name="test", info=info, time=time
+        )
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_xarray_03_2048x1024(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2048, 1024)), units="m")
+        xdata = full(0.0, "test", info, time)
+        data = strip_data(xdata)
+        _result = self.benchmark(
+            to_xarray, data=data, name="test", info=info, time=time
+        )
+
+
+class TestFull(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        _result = self.benchmark(full, value=0.0, name="test", info=info, time=time)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        _result = self.benchmark(full, value=0.0, name="test", info=info, time=time)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_03_2048x1024(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2048, 1024)), units="m")
+        _result = self.benchmark(full, value=0.0, name="test", info=info, time=time)
+
+
+class TestFullLike(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_like_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(full_like, xdata=xdata, value=0.0)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_like_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(full_like, xdata=xdata, value=0.0)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_full_like_03_2048x1024(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2048, 1024)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(full_like, xdata=xdata, value=0.0)
+
+
+class TestTimeTools(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_strip_time(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(strip_time, xdata=xdata)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_assign_time_update(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(assign_time, xdata=xdata, time=dt.datetime(2000, 1, 2))
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_assign_time_add(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        xdata = strip_time(xdata)
+        _result = self.benchmark(assign_time, xdata=xdata, time=dt.datetime(2000, 1, 2))
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_get_time(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(get_time, xdata=xdata)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_has_time(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(has_time, xdata=xdata)
+
+
+class TestUnitsTools(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def setupBenchmark(self, benchmark):
+        self.benchmark = benchmark
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_get_units(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(get_units, xdata=xdata)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_units_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(to_units, xdata=xdata, units="in")
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_units_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(to_units, xdata=xdata, units="in")
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_to_units_03_2048x1024(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2048, 1024)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(to_units, xdata=xdata, units="in")
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_get_magnitude_01_2x1(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2, 1)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(get_magnitude, xdata=xdata)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_get_magnitude_02_512x256(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((512, 256)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(get_magnitude, xdata=xdata)
+
+    @pytest.mark.benchmark(group="data-tools")
+    def test_get_magnitude_03_2048x1024(self):
+        time = dt.datetime(2000, 1, 1)
+        info = fm.Info(time=time, grid=fm.UniformGrid((2048, 1024)), units="m")
+        xdata = full(0.0, "test", info, time)
+        _result = self.benchmark(get_magnitude, xdata=xdata)

pyproject.toml

@@ -65,7 +65,10 @@ doc = [
     "docutils>=0.18", # mdinclude with myst
     "matplotlib>=3",
 ]
-test = ["pytest-cov>=3"]
+test = [
+    "pytest-cov>=3",
+    "pytest-benchmark[histogram]>=4.0",
+]
 
 [tool.setuptools]
 license-files = ["LICENSE"]