sdfio 1.0.0__tar.gz

sdfio-1.0.0/.gitignore

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+# Byte-compiled / optimized files
+__pycache__/
+*.py[cod]
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+MANIFEST
+
+# Environments
+.venv/
+venv/
+env/
+.env
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.dmypy.json
+.ruff_cache/
+.coverage
+.coverage.*
+coverage.xml
+*.cover
+htmlcov/
+
+# Documentation build output
+docs/_build/
+
+# Packaging credentials
+.pypirc

sdfio-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.7
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: "0.26"
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.51"
+    hooks:
+      - id: check-manifest
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: vulture
+        name: vulture
+        entry: vulture
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: bandit
+        name: bandit
+        entry: bandit -c pyproject.toml -r src
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: reuse
+        name: reuse lint
+        entry: reuse lint
+        language: system
+        pass_filenames: false

sdfio-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thomas Ascher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdfio-1.0.0/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

sdfio-1.0.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.5
+Name: sdfio
+Version: 1.0.0
+Summary: Read and write ISO 25178-71 SDF surface data files
+Project-URL: Homepage, https://github.com/aschet/sdfio
+Project-URL: Documentation, https://aschet.github.io/sdfio/
+Project-URL: Source, https://github.com/aschet/sdfio
+Project-URL: Issues, https://github.com/aschet/sdfio/issues
+Project-URL: Changelog, https://github.com/aschet/sdfio/releases
+Author-email: Thomas Ascher <thomas.ascher@gmx.at>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: iso-25178,metrology,sdf,surface-texture
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: defusedxml>=0.7
+Requires-Dist: numpy>=1.24
+Description-Content-Type: text/markdown
+
+# sdfio
+
+[![CI](https://github.com/aschet/sdfio/actions/workflows/ci.yml/badge.svg)](https://github.com/aschet/sdfio/actions/workflows/ci.yml)
+[![Docs](https://github.com/aschet/sdfio/actions/workflows/docs.yml/badge.svg)](https://aschet.github.io/sdfio/)
+
+<!-- docs-include-start -->
+
+Read and write ISO 25178-71 Surface Data Files (`.sdf`) in Python.
+
+SDF stores areal (or profile) surface topography measurements as a
+rectangular grid of height values, in either a human-readable ASCII or a
+compact binary format. It is used as a software measurement standard
+(a "softgauge") to verify the software of surface texture measuring
+instruments, and is also used more generally as a surface topography
+interchange format.
+
+Supported dialects: ISO-1.0, ISO-2.0, and BCR-1.0 (the
+pre-standardization proposal this format is based on), without
+compression or checksummed data areas. Vendor-specific extensions are not
+supported.
+
+## Installation
+
+```bash
+pip install sdfio
+```
+
+## Usage
+
+```python
+import numpy as np
+import sdfio
+
+data = np.zeros((480, 640))
+
+sdfio.write("surface.sdf", data, x_scale=1e-6, y_scale=1e-6, z_scale=1e-9)
+
+sdf = sdfio.read("surface.sdf")
+print(sdf.data.shape)
+print(sdf.header)
+```
+
+`sdf.data` is a `(num_profiles, num_points)` array of height values in
+metres, in the standard's right-handed coordinate system: y increases with
+row index and x with column index (`sdfio.SdfFile.x_axis`/`y_axis` return
+the coordinates, also in metres).
+
+Non-measured or spurious points (the `BAD` marker in ASCII files, or the
+data type's reserved sentinel value in binary files) are represented as
+`NaN` in `sdf.data`, and `sdfio.write` writes `NaN` values back the same way.
+
+## Command Line
+
+```bash
+sdfio info surface.sdf
+sdfio convert -f ascii surface.sdf surface_ascii.sdf
+sdfio convert -d ISO-1.0 -r surface_v2.sdf surface_v1.sdf
+sdfio convert -t int16 surface.sdf surface_int16.sdf
+```
+
+`convert` can change the ASCII/binary format (`-f`/`--format`), the SDF
+dialect and version (`-d`/`--dialect`, e.g. `ISO-2.0` or `BCR-1.0`), and the
+data area storage type (`-t`/`--type`) independently; any not given are kept
+from the source file. Converting to a dialect whose trailer requirements the
+source file doesn't meet fails unless `-r`/`--remove-trailer` is passed to
+discard it. Run `sdfio convert --help` for details. The CLI is also runnable
+as `python -m sdfio`.
+
+## Development
+
+```bash
+python3 -m venv .venv  # Windows: python -m venv .venv
+source .venv/bin/activate  # Windows (PowerShell): .venv\Scripts\Activate.ps1
+pip install -e . --group dev
+pre-commit install
+pytest
+pre-commit run --all-files
+pip-audit
+```
+
+## References
+
+- ISO 25178-71:2026, *Geometrical product specifications (GPS) — Surface
+  texture: Areal — Part 71: SDF file format*
+- K. J. Stout et al., *The Development of Methods for the Characterisation of
+  Roughness in Three Dimensions*, EUR 15178 EN, EC Brussels, 1993

sdfio-1.0.0/README.md

@@ -0,0 +1,86 @@
+# sdfio
+
+[![CI](https://github.com/aschet/sdfio/actions/workflows/ci.yml/badge.svg)](https://github.com/aschet/sdfio/actions/workflows/ci.yml)
+[![Docs](https://github.com/aschet/sdfio/actions/workflows/docs.yml/badge.svg)](https://aschet.github.io/sdfio/)
+
+<!-- docs-include-start -->
+
+Read and write ISO 25178-71 Surface Data Files (`.sdf`) in Python.
+
+SDF stores areal (or profile) surface topography measurements as a
+rectangular grid of height values, in either a human-readable ASCII or a
+compact binary format. It is used as a software measurement standard
+(a "softgauge") to verify the software of surface texture measuring
+instruments, and is also used more generally as a surface topography
+interchange format.
+
+Supported dialects: ISO-1.0, ISO-2.0, and BCR-1.0 (the
+pre-standardization proposal this format is based on), without
+compression or checksummed data areas. Vendor-specific extensions are not
+supported.
+
+## Installation
+
+```bash
+pip install sdfio
+```
+
+## Usage
+
+```python
+import numpy as np
+import sdfio
+
+data = np.zeros((480, 640))
+
+sdfio.write("surface.sdf", data, x_scale=1e-6, y_scale=1e-6, z_scale=1e-9)
+
+sdf = sdfio.read("surface.sdf")
+print(sdf.data.shape)
+print(sdf.header)
+```
+
+`sdf.data` is a `(num_profiles, num_points)` array of height values in
+metres, in the standard's right-handed coordinate system: y increases with
+row index and x with column index (`sdfio.SdfFile.x_axis`/`y_axis` return
+the coordinates, also in metres).
+
+Non-measured or spurious points (the `BAD` marker in ASCII files, or the
+data type's reserved sentinel value in binary files) are represented as
+`NaN` in `sdf.data`, and `sdfio.write` writes `NaN` values back the same way.
+
+## Command Line
+
+```bash
+sdfio info surface.sdf
+sdfio convert -f ascii surface.sdf surface_ascii.sdf
+sdfio convert -d ISO-1.0 -r surface_v2.sdf surface_v1.sdf
+sdfio convert -t int16 surface.sdf surface_int16.sdf
+```
+
+`convert` can change the ASCII/binary format (`-f`/`--format`), the SDF
+dialect and version (`-d`/`--dialect`, e.g. `ISO-2.0` or `BCR-1.0`), and the
+data area storage type (`-t`/`--type`) independently; any not given are kept
+from the source file. Converting to a dialect whose trailer requirements the
+source file doesn't meet fails unless `-r`/`--remove-trailer` is passed to
+discard it. Run `sdfio convert --help` for details. The CLI is also runnable
+as `python -m sdfio`.
+
+## Development
+
+```bash
+python3 -m venv .venv  # Windows: python -m venv .venv
+source .venv/bin/activate  # Windows (PowerShell): .venv\Scripts\Activate.ps1
+pip install -e . --group dev
+pre-commit install
+pytest
+pre-commit run --all-files
+pip-audit
+```
+
+## References
+
+- ISO 25178-71:2026, *Geometrical product specifications (GPS) — Surface
+  texture: Areal — Part 71: SDF file format*
+- K. J. Stout et al., *The Development of Methods for the Characterisation of
+  Roughness in Three Dimensions*, EUR 15178 EN, EC Brussels, 1993

sdfio-1.0.0/REUSE.toml

@@ -0,0 +1,6 @@
+version = 1
+
+[[annotations]]
+path = ["README.md"]
+SPDX-FileCopyrightText = "2026 Thomas Ascher <thomas.ascher@gmx.at>"
+SPDX-License-Identifier = "MIT"

sdfio-1.0.0/docs/api.rst

@@ -0,0 +1,11 @@
+.. SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+..
+.. SPDX-License-Identifier: MIT
+
+API Reference
+=============
+
+.. automodule:: sdfio
+   :members:
+   :imported-members:
+   :show-inheritance:

sdfio-1.0.0/docs/conf.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+"""Sphinx configuration for the sdfio documentation."""
+
+from __future__ import annotations
+
+import sdfio
+
+project = "sdfio"
+copyright = "2026, Thomas Ascher"
+author = "Thomas Ascher"
+release = sdfio.__version__
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "myst_parser",
+]
+
+autodoc_member_order = "bysource"
+autodoc_default_options = {"members": True, "imported-members": True}
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
+
+html_theme = "furo"

sdfio-1.0.0/docs/index.md

@@ -0,0 +1,18 @@
+<!--
+SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+
+SPDX-License-Identifier: MIT
+-->
+
+# sdfio
+
+```{include} ../README.md
+:relative-images:
+:start-after: <!-- docs-include-start -->
+```
+
+```{toctree}
+:hidden:
+
+api
+```

sdfio-1.0.0/pyproject.toml

@@ -0,0 +1,114 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+[build-system]
+requires = ["hatchling>=1.24"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sdfio"
+dynamic = ["version"]
+description = "Read and write ISO 25178-71 SDF surface data files"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Thomas Ascher", email = "thomas.ascher@gmx.at" }]
+keywords = ["sdf", "iso-25178", "surface-texture", "metrology"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering",
+    "Typing :: Typed",
+]
+dependencies = ["defusedxml>=0.7", "numpy>=1.24"]
+
+[project.urls]
+Homepage = "https://github.com/aschet/sdfio"
+Documentation = "https://aschet.github.io/sdfio/"
+Source = "https://github.com/aschet/sdfio"
+Issues = "https://github.com/aschet/sdfio/issues"
+Changelog = "https://github.com/aschet/sdfio/releases"
+
+[project.scripts]
+sdfio = "sdfio.cli:main"
+
+[dependency-groups]
+dev = [
+    "bandit[toml]>=1.7",
+    "build>=1.2",
+    "mypy>=1.10",
+    "pip-audit>=2.7",
+    "pre-commit>=3.7",
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "reuse>=5.0",
+    "ruff>=0.5",
+    "twine>=5.1",
+    "types-defusedxml>=0.7",
+    "vulture>=2.11",
+]
+docs = ["furo>=2024.8", "myst-parser>=4.0", "sphinx>=8.0"]
+
+[tool.hatch.version]
+path = "src/sdfio/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sdfio"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/docs",
+    "/README.md",
+    "/LICENSE",
+    "/LICENSES",
+    "/REUSE.toml",
+    "/.pre-commit-config.yaml",
+]
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+addopts = "--doctest-modules --strict-markers --strict-config --import-mode=importlib"
+testpaths = ["tests", "src"]
+
+[tool.coverage.report]
+fail_under = 75
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "C4", "SIM", "RUF", "D", "NPY", "PT", "ERA", "S"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D100", "D101", "D102", "D103", "S101"]
+
+[tool.ruff.format]
+exclude = ["*.md"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.mypy]
+files = ["src", "tests"]
+strict = true
+
+[tool.vulture]
+paths = ["src"]
+min_confidence = 80
+
+[tool.bandit]
+exclude_dirs = ["tests"]

sdfio-1.0.0/src/sdfio/__init__.py

@@ -0,0 +1,64 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+"""sdfio: read and write ISO 25178-71 SDF surface data files.
+
+The Surface Data File (SDF) format is defined by ISO 25178-71, "Geometrical
+product specifications (GPS) -- Surface texture: Areal -- Part 71: Software
+measurement standards". It stores areal (or profile) surface topography
+measurements as a rectangular grid of height values, in either a
+human-readable ASCII or a compact binary format.
+
+Basic usage::
+
+    >>> import os
+    >>> import tempfile
+    >>> import numpy as np
+    >>> import sdfio
+    >>> path = os.path.join(tempfile.mkdtemp(), "example.sdf")
+    >>> sdfio.write(path, np.zeros((2, 3)), x_scale=1e-6, y_scale=1e-6)
+    >>> sdf = sdfio.read(path)
+    >>> sdf.data.shape
+    (2, 3)
+    >>> sdf.header.z_scale
+    1e-06
+"""
+
+from __future__ import annotations
+
+from .datatypes import (
+    DATA_TYPES,
+    DataType,
+    SdfDataType,
+    decode_raw,
+    encode_raw,
+    get_data_type,
+    suggest_z_scale,
+)
+from .exceptions import SdfError, SdfFormatError, SdfVersionError
+from .file import FileFormat, SdfFile, read, write
+from .header import SdfDialect, SdfHeader, SdfMetadata
+
+__all__ = [
+    "DATA_TYPES",
+    "DataType",
+    "FileFormat",
+    "SdfDataType",
+    "SdfDialect",
+    "SdfError",
+    "SdfFile",
+    "SdfFormatError",
+    "SdfHeader",
+    "SdfMetadata",
+    "SdfVersionError",
+    "__version__",
+    "decode_raw",
+    "encode_raw",
+    "get_data_type",
+    "read",
+    "suggest_z_scale",
+    "write",
+]
+
+__version__ = "1.0.0"

sdfio-1.0.0/src/sdfio/__main__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2026 Thomas Ascher <thomas.ascher@gmx.at>
+#
+# SPDX-License-Identifier: MIT
+
+"""Allow running the CLI as ``python -m sdfio``."""
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())