sgn-dq 0.0.1__tar.gz

sgn_dq-0.0.1/.gitignore

@@ -0,0 +1,10 @@
+*.egg-info
+build/
+dist/
+site/
+__pycache__
+_version.py
+.coverage
+.vscode/
+.idea/
+*.patch

sgn_dq-0.0.1/.gitlab-ci.yml

@@ -0,0 +1,50 @@
+include:
+  # -- python
+  - component: git.ligo.org/computing/gitlab/components/python/sdist@1
+  - component: git.ligo.org/computing/gitlab/components/python/wheel@1
+  - component: git.ligo.org/computing/gitlab/components/python/code-quality@1
+    inputs:
+      analyzer: "ruff"
+      requirements: "-r requirements-lint.txt"
+  - component: git.ligo.org/computing/gitlab/components/python/dependency-scanning@1
+  - component: git.ligo.org/computing/gitlab/components/python/type-checking@1
+    inputs:
+      project_dir: "src"
+  - component: git.ligo.org/computing/gitlab/components/python/test@1
+    inputs:
+      install_extra: test
+      python_versions:
+        - "3.11"
+        - "3.12"
+        - "3.13"
+  # -- docs
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/build@1
+    inputs:
+      requirements: "-r requirements-docs.txt"
+  - component: git.ligo.org/computing/gitlab/components/mkdocs/pages@1
+    inputs:
+      pages_when: "default"
+
+# -- customizations
+ruff:
+  needs:
+    - requirements
+
+mkdocs:
+  needs:
+    - requirements
+
+# -- requirements
+requirements:
+  stage: build
+  image: python:3.12
+  script:
+    - python -m pip install pipx
+    - pipx ensurepath
+    - source ~/.bashrc
+    - pipx install hatch
+    - hatch dep show requirements --feature docs > requirements-docs.txt
+    - hatch dep show requirements --feature lint > requirements-lint.txt
+  artifacts:
+    paths:
+      - requirements-*.txt

sgn_dq-0.0.1/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.0.1] - 2026-04-20
+
+- Initial release.
+
+[unreleased]: https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/compare/0.0.1...main
+[0.0.1]: https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/tags/0.0.1

sgn_dq-0.0.1/Makefile

@@ -0,0 +1,42 @@
+ifeq ($(PYTHONPATH),)
+	PYTHONPATH := src
+else
+	PYTHONPATH := src:$(PYTHONPATH)
+endif
+export PYTHONPATH
+
+.PHONY: all
+all : format lint check test
+
+.PHONY: help
+help :
+	@echo
+	@echo 'Commands:'
+	@echo
+	@echo '  make test                  run tests'
+	@echo '  make lint                  run linter'
+	@echo '  make format                run code formatter'
+	@echo '  make check                 run static type checker'
+	@echo '  make docs                  build documentation'
+	@echo
+
+.PHONY: test
+test :
+	pytest -v --cov=sgn_dq --cov-report=term-missing src/sgn_dq/tests
+
+.PHONY: lint
+lint :
+	ruff check
+
+.PHONY: format
+format :
+	ruff format
+	ruff check --fix
+
+.PHONY: check
+check :
+	mypy src
+
+.PHONY: docs
+docs :
+	mkdocs build -c

sgn_dq-0.0.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: sgn-dq
+Version: 0.0.1
+Summary: Data quality elements for sgn
+Project-URL: Homepage, https://git.ligo.org/detchar/sgn-dq/sgn-dq
+Project-URL: Documentation, https://detchar.docs.ligo.org/sgn-dq/sgn-dq
+Project-URL: Repository, https://git.ligo.org/detchar/sgn-dq/sgn-dq.git
+Project-URL: Issues, https://git.ligo.org/detchar/sgn-dq/sgn-dq/issues
+Author-email: Derek Davis <derek.davis@ligo.org>, Olivia Godwin <olivia.godwin@ligo.org>, Zach Yarbrough <zach.yarbrough@ligo.org>
+Maintainer-email: Derek Davis <derek.davis@ligo.org>, Olivia Godwin <olivia.godwin@ligo.org>, Zach Yarbrough <zach.yarbrough@ligo.org>
+License-Expression: GPL-3.0-or-later
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Requires-Dist: sgn-arrakis
+Requires-Dist: sgn-gwframe
+Requires-Dist: sgn-ligo
+Requires-Dist: sgn-ts
+Requires-Dist: sgn>=0.6
+Provides-Extra: dev
+Requires-Dist: markdown-callouts>=0.2; extra == 'dev'
+Requires-Dist: markdown-exec>=0.5; extra == 'dev'
+Requires-Dist: mkdocs-coverage>=0.2; extra == 'dev'
+Requires-Dist: mkdocs-gen-files>=0.3; extra == 'dev'
+Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'dev'
+Requires-Dist: mkdocs-material-igwn; extra == 'dev'
+Requires-Dist: mkdocs-section-index>=0.3; extra == 'dev'
+Requires-Dist: mkdocs>=1.3; extra == 'dev'
+Requires-Dist: mkdocstrings[python]; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: mypy-extensions; extra == 'dev'
+Requires-Dist: pip; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: toml>=0.10; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: markdown-callouts>=0.2; extra == 'docs'
+Requires-Dist: markdown-exec>=0.5; extra == 'docs'
+Requires-Dist: mkdocs-coverage>=0.2; extra == 'docs'
+Requires-Dist: mkdocs-gen-files>=0.3; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav>=0.4; extra == 'docs'
+Requires-Dist: mkdocs-material-igwn; extra == 'docs'
+Requires-Dist: mkdocs-section-index>=0.3; extra == 'docs'
+Requires-Dist: mkdocs>=1.3; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Requires-Dist: toml>=0.10; extra == 'docs'
+Provides-Extra: lint
+Requires-Dist: mypy; extra == 'lint'
+Requires-Dist: mypy-extensions; extra == 'lint'
+Requires-Dist: pip; extra == 'lint'
+Requires-Dist: ruff; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+<h1 align="center">sgn-dq</h1>
+
+<p align="center">Data quality elements for <a href="https://git.ligo.org/greg/sgn">sgn</a></p>
+
+<p align="center">
+  <a href="https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/pipelines/latest">
+    <img alt="ci" src="https://git.ligo.org/detchar/sgn-dq/sgn-dq/badges/main/pipeline.svg" />
+  </a>
+  <a href="https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/pipelines/latest">
+    <img alt="coverage" src="https://git.ligo.org/detchar/sgn-dq/sgn-dq/badges/main/coverage.svg" />
+  </a>
+  <a href="https://detchar.docs.ligo.org/sgn-dq/sgn-dq">
+    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
+  </a>
+</p>
+
+---
+
+## Resources
+
+* [Documentation](https://detchar.docs.ligo.org/sgn-dq/sgn-dq)
+* [Source Code](https://git.ligo.org/detchar/sgn-dq/sgn-dq)
+* [Issue Tracker](https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/issues)
+
+## Installation
+
+```
+pip install sgn-dq
+```

sgn_dq-0.0.1/README.md

@@ -0,0 +1,29 @@
+<h1 align="center">sgn-dq</h1>
+
+<p align="center">Data quality elements for <a href="https://git.ligo.org/greg/sgn">sgn</a></p>
+
+<p align="center">
+  <a href="https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/pipelines/latest">
+    <img alt="ci" src="https://git.ligo.org/detchar/sgn-dq/sgn-dq/badges/main/pipeline.svg" />
+  </a>
+  <a href="https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/pipelines/latest">
+    <img alt="coverage" src="https://git.ligo.org/detchar/sgn-dq/sgn-dq/badges/main/coverage.svg" />
+  </a>
+  <a href="https://detchar.docs.ligo.org/sgn-dq/sgn-dq">
+    <img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
+  </a>
+</p>
+
+---
+
+## Resources
+
+* [Documentation](https://detchar.docs.ligo.org/sgn-dq/sgn-dq)
+* [Source Code](https://git.ligo.org/detchar/sgn-dq/sgn-dq)
+* [Issue Tracker](https://git.ligo.org/detchar/sgn-dq/sgn-dq/-/issues)
+
+## Installation
+
+```
+pip install sgn-dq
+```

sgn_dq-0.0.1/docs/gen_ref_nav.py

@@ -0,0 +1,58 @@
+# Copyright (c) 2021, Timothee Mazzucotelli
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+"""Generate the code reference pages and navigation."""
+
+from pathlib import Path
+
+import mkdocs_gen_files
+
+nav = mkdocs_gen_files.Nav()
+
+src = Path("src")
+
+for path in sorted(src.joinpath("sgn_dq").rglob("*.py")):
+    if path.name[0] == "_" or "tests" in path.parts:
+        continue
+
+    # Module path relative to src/ (e.g., sgn_dq/sources/frame)
+    module_path = path.relative_to(src).with_suffix("")
+    # Doc path mirrors module structure
+    doc_path = path.relative_to(src).with_suffix(".md")
+    full_doc_path = Path("reference", doc_path)
+
+    parts = tuple(module_path.parts)
+
+    if parts[-1] == "__init__":
+        parts = parts[:-1]
+        doc_path = doc_path.with_name("index.md")
+        full_doc_path = full_doc_path.with_name("index.md")
+    elif parts[-1] == "__main__":
+        continue
+
+    nav[parts] = doc_path.as_posix()
+
+    with mkdocs_gen_files.open(full_doc_path, "w") as fd:
+        ident = ".".join(parts)
+        fd.write(f"::: {ident}")
+
+    mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(src))
+
+with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
+    nav_file.writelines(nav.build_literate_nav())
+
+changelog = Path("CHANGELOG.md")
+if changelog.exists():
+    with mkdocs_gen_files.open("changelog.md", "w") as fd:
+        fd.write(changelog.read_text())

sgn_dq-0.0.1/docs/index.md

@@ -0,0 +1 @@
+--8<-- "README.md"

sgn_dq-0.0.1/mkdocs.yml

@@ -0,0 +1,60 @@
+site_name: sgn-dq
+site_description: Data quality elements for sgn
+site_url: https://detchar.docs.ligo.org/sgn-dq/sgn-dq
+repo_url: https://git.ligo.org/detchar/sgn-dq/sgn-dq
+repo_name: detchar/sgn-dq/sgn-dq
+site_dir: site
+watch: [README.md, src/sgn_dq]
+
+nav:
+- Home:
+  - Overview: index.md
+# defer to gen-files + literate-nav
+- API Reference: reference/
+- Changelog: changelog.md
+
+theme:
+  name: material_igwn
+  features:
+    - content.code.copy
+    - content.code.annotate
+
+markdown_extensions:
+- admonition
+- callouts:
+    strip_period: no
+- pymdownx.highlight
+- pymdownx.inlinehilite
+- pymdownx.magiclink
+- pymdownx.snippets:
+    check_paths: true
+- pymdownx.superfences
+- toc:
+    permalink: true
+    toc_depth: 4
+
+plugins:
+- search
+- markdown-exec
+- gen-files:
+    scripts:
+    - docs/gen_ref_nav.py
+- literate-nav:
+    nav_file: SUMMARY.md
+- section-index
+- mkdocstrings:
+    handlers:
+      python:
+        paths: [src]
+        inventories:
+          - https://docs.python.org/3/objects.inv
+          - https://mkdocstrings.github.io/objects.inv
+          - https://mkdocstrings.github.io/griffe/objects.inv
+          - https://numpy.org/doc/stable/objects.inv
+        options:
+          docstring_style: numpy
+          docstring_options:
+            ignore_init_summary: yes
+          merge_init_into_class: yes
+          separate_signature: yes
+          show_root_full_path: no

sgn_dq-0.0.1/pyproject.toml

@@ -0,0 +1,217 @@
+[build-system]
+requires = [
+    "hatchling",
+    "hatch-vcs",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "sgn-dq"
+authors = [
+    { name = "Derek Davis", email = "derek.davis@ligo.org" },
+    { name = "Olivia Godwin", email = "olivia.godwin@ligo.org" },
+    { name = "Zach Yarbrough", email = "zach.yarbrough@ligo.org" },
+]
+maintainers = [
+    { name = "Derek Davis", email = "derek.davis@ligo.org" },
+    { name = "Olivia Godwin", email = "olivia.godwin@ligo.org" },
+    { name = "Zach Yarbrough", email = "zach.yarbrough@ligo.org" },
+]
+description = "Data quality elements for sgn"
+readme = "README.md"
+license = "GPL-3.0-or-later"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Astronomy",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dynamic = ["version"]
+requires-python = ">=3.11"
+dependencies = [
+    "sgn >= 0.6",
+    "sgn-arrakis",
+    "sgn-gwframe",
+    "sgn-ligo",
+    "sgn-ts",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+docs = [
+    "mkdocs >= 1.3",
+    "mkdocs-coverage >= 0.2",
+    "mkdocs-gen-files >= 0.3",
+    "mkdocs-literate-nav >= 0.4",
+    "mkdocs-material-igwn",
+    "mkdocs-section-index >= 0.3",
+    "mkdocstrings[python]",
+    "markdown-callouts >= 0.2",
+    "markdown-exec >= 0.5",
+    "toml >= 0.10",
+]
+lint = [
+    "mypy",
+    "mypy-extensions",
+    "pip",
+    "ruff",
+]
+dev = [
+    "sgn_dq[docs]",
+    "sgn_dq[lint]",
+    "sgn_dq[test]",
+]
+
+[project.urls]
+Homepage = "https://git.ligo.org/detchar/sgn-dq/sgn-dq"
+Documentation = "https://detchar.docs.ligo.org/sgn-dq/sgn-dq"
+Repository = "https://git.ligo.org/detchar/sgn-dq/sgn-dq.git"
+Issues = "https://git.ligo.org/detchar/sgn-dq/sgn-dq/issues"
+
+[project.entry-points.sgn_elements]
+ValidCheck = "sgn_dq.transforms.evaluators:ValidCheck"
+BitMaskCheck = "sgn_dq.transforms.evaluators:BitMaskCheck"
+OverflowCheck = "sgn_dq.transforms.evaluators:OverflowCheck"
+RmsCheck = "sgn_dq.transforms.evaluators:RmsCheck"
+BandRmsCheck = "sgn_dq.transforms.evaluators:BandRmsCheck"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/sgn_dq/_version.py"
+
+[tool.hatch.envs.default]
+features = ["dev"]
+installer = "uv"
+
+[tool.hatch.envs.default.scripts]
+check = "mypy --install-types --non-interactive sgn_dq"
+
+[tool.hatch.envs.docs]
+features = ["docs"]
+scripts.build = "mkdocs build --clean --strict"
+scripts.serve = "mkdocs serve"
+
+[tool.hatch.envs.hatch-static-analysis]
+config-path = "none"
+
+[tool.hatch.envs.hatch-test]
+features = ["test"]
+default-args = ["sgn_dq/tests"]
+extra-args = ["-ra", "-v", "-s"]
+
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.11", "3.12", "3.13"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=sgn_dq --cov-report=term-missing"
+
+[tool.coverage.paths]
+source = [
+    "src/sgn_dq/",
+    "*/sgn_dq/",
+]
+
+[tool.coverage.run]
+source = ["sgn_dq"]
+omit = [
+    "sgn_dq/tests/*",
+    "__init__.py",
+    "_version.py",
+]
+
+[tool.coverage.report]
+precision = 1
+show_missing = true
+omit = [
+    "sgn_dq/tests/*",
+    "__init__.py",
+    "_version.py",
+]
+
+[tool.mypy]
+check_untyped_defs = true
+ignore_missing_imports = true
+exclude = [
+    "docs",
+    "build",
+    "tests",
+]
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    "W",
+    # pyflakes
+    "F",
+    # isort
+    "I",
+    # pep8-naming
+    "N",
+    # flake8-bandit
+    "S",
+    # flake8-blind-except
+    "BLE",
+    # flake8-boolean-trap
+    "FBT",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-datetimez
+    "DTZ",
+    # flake8-errmsg
+    "EM",
+    # flake8-executable
+    "EXE",
+    # flake8-future-annotations
+    "FA",
+    # flake8-logging
+    "LOG",
+    # flake8-logging-format
+    "G",
+    # flake8-pytest-style
+    "PT",
+    # flake8-return
+    "RET",
+    # flake8-self
+    "SLF",
+    # flake8-simplify
+    "SIM",
+    # flake8-slots
+    "SLOT",
+    # flake8-type-checking
+    "TCH",
+    # tryceratops
+    "TRY",
+    # refurb
+    "FURB",
+    # ruff-specific rules
+    "RUF",
+]
+ignore = [
+    "E203",  # flags whitespace on slicing
+    "S101",  # assert statements
+    "B905",  # strict zip
+    "C414",  # unnecessary double-cast
+    "PT011", # pytest generic raises
+    "PT018", # assertion into multiple parts 
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"**/tests/*" = ["SLF001"]
+"**/cli.py" = ["B008", "FBT001", "FBT002", "FBT003"]

sgn_dq-0.0.1/src/sgn_dq/__init__.py

@@ -0,0 +1 @@
+"""Data quality elements for sgn."""

sgn_dq-0.0.1/src/sgn_dq/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None