signal-dataset 0.2.0__tar.gz

signal_dataset-0.2.0/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,15 @@
+name: Bug report
+description: Report a reproducible Signal Dataset defect
+body:
+  - type: textarea
+    attributes: {label: Description}
+    validations: {required: true}
+  - type: input
+    attributes: {label: signal-dataset version}
+    validations: {required: true}
+  - type: input
+    attributes: {label: Python and operating system}
+    validations: {required: true}
+  - type: textarea
+    attributes: {label: Minimal reproducer and exception}
+    validations: {required: true}

signal_dataset-0.2.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Security vulnerability
+    url: https://github.com/superpose-labs/signal-dataset/security/advisories/new
+    about: Report vulnerabilities privately; do not open a public issue.
+  - name: Support guidance
+    url: https://github.com/superpose-labs/signal-dataset/blob/main/SUPPORT.md
+    about: Read the information needed for support requests.

signal_dataset-0.2.0/.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,9 @@
+name: Documentation issue
+description: Report unclear, missing, or incorrect documentation
+body:
+  - type: input
+    attributes: {label: Page or section}
+    validations: {required: true}
+  - type: textarea
+    attributes: {label: Problem and suggested improvement}
+    validations: {required: true}

signal_dataset-0.2.0/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,11 @@
+name: Feature or design proposal
+description: Propose a capability or public design change
+body:
+  - type: textarea
+    attributes: {label: Problem and users}
+    validations: {required: true}
+  - type: textarea
+    attributes: {label: Proposed behavior and alternatives}
+    validations: {required: true}
+  - type: textarea
+    attributes: {label: Compatibility or format impact}

signal_dataset-0.2.0/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Summary
+
+## Compatibility and persisted-format impact
+
+## Validation
+
+- [ ] Tests added or updated
+- [ ] Ruff, strict mypy, and pytest pass
+- [ ] Documentation updated
+- [ ] RFC included when public API or persisted conventions change

signal_dataset-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches: [main]
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        with:
+          python-version: ${{ matrix.python }}
+          enable-cache: true
+      - run: uv sync --all-extras --dev --locked
+      - run: uv run pytest --cov=signal_dataset --cov-branch --cov-report=term-missing --cov-fail-under=90
+      - run: uv run ruff check .
+      - run: uv run mypy src/signal_dataset
+      - run: uv build
+      - run: uv run python benchmarks/benchmark_core.py > benchmark-results.json
+      - name: Wheel and sdist journeys
+        run: |
+          uv venv .journey-wheel
+          uv pip install --python .journey-wheel/bin/python dist/*.whl
+          .journey-wheel/bin/python - <<'PY'
+          import tempfile
+          import numpy as np
+          import signal_dataset as s
+          root = tempfile.mkdtemp() + "/journey.sds"
+          record = s.Record("one", {"x": s.Field(np.arange(2), (s.Axis("sample", 2),))})
+          shard = s.write_shard([record], root)
+          assert s.publish(root, [shard], dataset_id="journey", snapshot_id="run")[0].id == "one"
+          try:
+              s.storage.GCSObjectStore()
+          except ImportError as exc:
+              assert "gcs" in str(exc)
+          else:
+              raise AssertionError("base wheel unexpectedly includes the GCS extra")
+          PY
+          uv venv .journey-gcs
+          uv pip install --python .journey-gcs/bin/python "$(find dist -name '*.whl' -print -quit)[gcs]"
+          .journey-gcs/bin/python - <<'PY'
+          from google.cloud import storage
+          from signal_dataset.storage import GCSObjectStore
+          class Client: pass
+          assert storage is not None
+          assert GCSObjectStore(client=Client()) is not None
+          PY
+          mkdir .journey-sdist
+          ! tar -tzf dist/*.tar.gz | grep '/.hypothesis/'
+          tar -xzf dist/*.tar.gz -C .journey-sdist
+          cd "$(find .journey-sdist -mindepth 1 -maxdepth 1 -type d -print -quit)"
+          uv run --isolated pytest
+      - name: Validate benchmark results
+        run: |
+          python - <<'PY'
+          import json, math
+          value = json.load(open("benchmark-results.json"))
+          assert value["record_count"] > 1 and value["shard_count"] > 1
+          samples = [value["encode_s"], value["decode_s"], value["open_s"], value["metadata_read_s"], *value["random_read_s"]]
+          assert len(value["random_ordinals"]) == len(value["random_read_s"])
+          assert len(set(value["random_ordinals"])) > 1
+          assert all(math.isfinite(item) and item >= 0 for item in samples)
+          PY
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: benchmarks-${{ matrix.os }}-py${{ matrix.python }}
+          path: benchmark-results.json

signal_dataset-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Documentation
+on:
+  pull_request:
+  push:
+    branches: [main]
+permissions:
+  contents: read
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+      - run: uv sync --all-extras --dev --locked
+      - run: uv run mkdocs build --strict
+      - uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2.9.0
+        with:
+          args: --no-progress --retry-wait-time 2 --max-retries 3 README.md docs/*.md docs/**/*.md *.md
+  deploy:
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    needs: build
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+      - run: uv sync --all-extras --dev --locked
+      - run: uv run mkdocs gh-deploy --force

signal_dataset-0.2.0/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+on:
+  push:
+    tags: ["v*"]
+permissions:
+  contents: read
+  id-token: write
+jobs:
+  publish:
+    if: github.repository == 'superpose-labs/signal-dataset'
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        with:
+          python-version: "3.13"
+      - name: Verify tag matches package version
+        run: |
+          version=$(uv version --short)
+          test "${GITHUB_REF_NAME}" = "v${version}"
+          grep -F "## ${version}" CHANGELOG.md
+          ! grep -F "## ${version} — Unreleased" CHANGELOG.md
+      - run: uv sync --all-extras --dev --locked
+      - run: uv run pytest --cov=signal_dataset --cov-branch --cov-fail-under=90
+      - run: uv run ruff check .
+      - run: uv run mypy src/signal_dataset
+      - run: uv run mkdocs build --strict
+      - run: uv build
+      - name: Verify built wheel
+        run: |
+          uv venv .release-check
+          uv pip install --python .release-check/bin/python dist/*.whl
+          expected="${GITHUB_REF_NAME#v}"
+          .release-check/bin/python -c 'import signal_dataset, sys; assert signal_dataset.__version__ == sys.argv[1]' "$expected"
+      - name: Repeat artifact journeys
+        run: |
+          uv venv .release-base
+          uv pip install --python .release-base/bin/python dist/*.whl
+          .release-base/bin/python -c 'import signal_dataset; signal_dataset.storage.GCSObjectStore()' 2>&1 | grep "gcs"
+          uv venv .release-gcs
+          uv pip install --python .release-gcs/bin/python "$(find dist -name '*.whl' -print -quit)[gcs]"
+          .release-gcs/bin/python -c 'from google.cloud import storage; from signal_dataset.storage import GCSObjectStore; assert storage and GCSObjectStore(client=object())'
+          mkdir .release-sdist
+          tar -xzf dist/*.tar.gz -C .release-sdist
+          ! find .release-sdist -path '*/.hypothesis/*' -print -quit | grep .
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # release/v1

signal_dataset-0.2.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+dist/
+site/
+__pycache__/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+.coverage
+.DS_Store

signal_dataset-0.2.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.2.0 — 2026-08-12
+
+- Reorganized the Python API into record, storage, dataset, and annotation namespaces.
+- Standardized extension contracts and `object_store` terminology.
+- Preserved persisted record and dataset layout version 0.1.
+- Strengthened annotation catalog, descriptor, and mapped-index validation.
+- Expanded compatibility, packaging, platform, and community documentation.
+
+## 0.1.0 — 2026-08-12
+
+- Initial experimental release of the profile-free record model, SafeTensors codec, immutable
+  ArrayRecord datasets, deterministic indexed reads, and local/GCS storage.

signal_dataset-0.2.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+# Code of Conduct
+
+We pledge to make participation in Signal Dataset welcoming and harassment-free, regardless of
+background, identity, experience, or viewpoint. Be respectful, assume good intent while addressing
+impact, keep technical criticism specific, and do not publish private information.
+
+Maintainers may edit or remove abusive, threatening, discriminatory, or persistently disruptive
+contributions and may temporarily or permanently restrict participation. Report conduct concerns
+privately through the repository's GitHub private-reporting form, prefixing the title `CONDUCT:`.
+The active maintainer team receives reports. Any maintainer named in or materially conflicted with a
+report must recuse; the remaining maintainer, or an uninvolved Superpose Labs administrator, owns
+the response. Reports are handled confidentially and without retaliation.
+
+This policy applies in project spaces and when representing the project elsewhere.

signal_dataset-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+Install the locked development environment with `uv sync --all-extras --dev`. Before opening a
+pull request, run `uv run ruff check .`, `uv run mypy src/signal_dataset`, and `uv run pytest`.
+
+Changes to a public API or persisted convention require an RFC in `rfcs/`. Keep the core format
+profile-free and avoid dependencies on generation or training frameworks.
+
+Follow the dependency direction in `docs/architecture.md`: logical values/codecs belong in
+`record`, transport/container extensions in `storage`, dataset orchestration in `dataset`, and
+snapshot-aligned derived data in `annotation`. Pull requests should include focused tests,
+user-facing documentation for behavior changes, and a changelog entry for external changes.

signal_dataset-0.2.0/GOVERNANCE.md

@@ -0,0 +1,13 @@
+# Governance
+
+Superpose Labs maintains the experimental 0.x releases. Maintainers review compatibility,
+security, and format changes in public. Material persisted-format changes use repository RFCs.
+
+Maintainers may merge routine fixes after review and passing checks. Public API, security-boundary,
+governance, and compatibility decisions require explicit maintainer approval; persisted-format
+changes additionally require an accepted RFC. RFCs record alternatives and migration impact.
+
+Release managers verify the tag, changelog, locked environment, documentation, artifacts, and
+installed-package journeys before approving the protected PyPI environment. Maintainer access is
+earned through sustained technical and community contributions. If Superpose Labs can no longer
+maintain the project, it will seek active community successors and document the transfer publicly.

signal_dataset-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

signal_dataset-0.2.0/MIGRATION.md

@@ -0,0 +1,49 @@
+# Migrating from 0.1 to 0.2
+
+Package 0.2 is a deliberate Python API cleanup. Persisted dataset layout and record encoding remain
+version 0.1; republishing data is not required.
+
+| 0.1 API | 0.2 API |
+| --- | --- |
+| `BaseCodec` | `signal_dataset.record.RecordCodec` |
+| `BaseObjectStore` | `signal_dataset.storage.ObjectStore` |
+| `BaseShardStore` | `signal_dataset.storage.ShardStore` |
+| `encode_record`, `decode_record` | `signal_dataset.record.encode`, `.decode` |
+| `open_dataset` | `signal_dataset.open` |
+| `backend=` | `object_store=` |
+| `write_annotation_shard` | `signal_dataset.annotation.write_shard` |
+| `publish_annotation_shards` | `signal_dataset.annotation.publish_shards` |
+| top-level `LocalObjectStore` | `signal_dataset.storage.LocalObjectStore` |
+| top-level `GCSObjectStore` | `signal_dataset.storage.GCSObjectStore` |
+| top-level `ArrayRecordShardStore` | `signal_dataset.storage.ArrayRecordShardStore` |
+| top-level `RecordShardWriter` | `signal_dataset.dataset.RecordShardWriter` |
+| top-level `SafeTensorsRecordCodec` | `signal_dataset.record.SafeTensorsRecordCodec` |
+| top-level `RecordMetadataCodec` | `signal_dataset.record.RecordMetadataCodec` |
+| top-level `SafeTensorsAnnotationCodec` | `signal_dataset.annotation.SafeTensorsAnnotationCodec` |
+
+The compatibility aliases `StorageBackend`, `LocalBackend`, `GcsBackend`, `ShardStore` (old alias),
+and `ArrayRecordStore` were removed. Import concrete implementations from `signal_dataset.storage`.
+
+Before:
+
+```python
+class Store(sds.BaseObjectStore): ...
+
+
+dataset = sds.open_dataset(uri, backend=Store())
+writer = sds.RecordShardWriter(objects=Store(), shards=custom_shards)
+```
+
+After:
+
+```python
+from signal_dataset.dataset import RecordShardWriter
+from signal_dataset.storage import ObjectStore
+
+
+class Store(ObjectStore): ...
+
+
+dataset = sds.open(uri, object_store=Store())
+writer = RecordShardWriter(object_store=Store(), shard_store=custom_shards)
+```

signal_dataset-0.2.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.5
+Name: signal-dataset
+Version: 0.2.0
+Summary: An open, profile-free format and Python library for large-scale multidimensional signal datasets.
+Project-URL: Documentation, https://superpose-labs.github.io/signal-dataset/
+Project-URL: Issues, https://github.com/superpose-labs/signal-dataset/issues
+Project-URL: Repository, https://github.com/superpose-labs/signal-dataset
+Author: Superpose Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: <3.14,>=3.11
+Requires-Dist: array-record<0.9,>=0.8.3
+Requires-Dist: numpy<2.5,>=1.26
+Requires-Dist: safetensors<0.9,>=0.5
+Provides-Extra: gcs
+Requires-Dist: google-cloud-storage<4,>=3; extra == 'gcs'
+Description-Content-Type: text/markdown
+
+# Signal Dataset
+
+Immutable, indexed storage for multidimensional signal records on local filesystems and GCS.
+Numerical fields use SafeTensors; ArrayRecord provides random access.
+
+> **Status:** experimental 0.x software. The Python API may make documented breaking changes
+> between minor releases. Persisted-format compatibility is versioned separately.
+
+```python
+import numpy as np
+import signal_dataset as sds
+
+record = sds.Record(
+    id="capture-0042",
+    fields={
+        "iq": sds.Field(
+            np.zeros((4, 4096), dtype=np.complex64),
+            axes=(sds.Axis("channel", 4), sds.Axis("time", 4096)),
+        )
+    },
+    metadata={"sample_rate_hz": 20_000_000},
+)
+
+shard = sds.write_shard([record], "captures.sds", work_id="worker-000")
+dataset = sds.publish(
+    "captures.sds",
+    [shard],
+    dataset_id="captures",
+    snapshot_id="run-001",
+)
+
+assert dataset[0].id == "capture-0042"
+assert dataset.record_metadata[0]["iq"].shape == (4, 4096)
+```
+
+`dataset.record_metadata[index]` reads the aligned metadata shard without fetching signal tensors.
+Readers follow generation-pinned manifests and never list directories or GCS prefixes.
+
+See the [quickstart](docs/quickstart.md), [annotation example](docs/how-to/annotations.md), and
+[distributed-writing guide](docs/how-to/distributed-writing.md).
+
+## Install
+
+```bash
+uv add signal-dataset
+uv add 'signal-dataset[gcs]'  # GCS transport
+```
+
+Equivalent pip commands are `pip install signal-dataset` and
+`pip install 'signal-dataset[gcs]'`.
+
+Python 3.11–3.13 on Linux and macOS are supported. Windows is not currently supported because the
+local atomic-publication implementation uses POSIX filesystem primitives.
+
+## Design
+
+- Immutable, root-last publication: readers observe no dataset or a complete snapshot.
+- Lazy ordinal random access without directory or bucket-prefix discovery.
+- Tensor-free aligned metadata reads.
+- Storage and shard-container extension contracts.
+- Profile-free records: no modality, training framework, or split policy is embedded in the core.
+
+The project does not provide mutable datasets, distributed scheduling, authorization, retention,
+or batching policy. See the [architecture](docs/architecture.md), [format compatibility
+contract](docs/concepts/compatibility.md), and [roadmap](ROADMAP.md).
+
+Signal Dataset is use-case agnostic. It has no training-framework, modality, or split-policy
+dependency.
+
+## Community
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) before proposing changes. Use GitHub Issues for reproducible
+bugs and design discussion, and follow [SECURITY.md](SECURITY.md) for private vulnerability reports.
+Participation is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).