Update Hugging Face DOI

CITATION.cff

@@ -1,9 +1,11 @@
 cff-version: 1.2.0
-message: "If you use SeismicX-Cont, please cite the dataset repository and the accompanying ESSD manuscript."
-title: "SeismicX-Cont: A continuous-waveform seismic dataset for monitoring workflow validation"
+message: "If you use SeismicX-Cont, please cite the dataset DOI, the accompanying ESSD manuscript, and the original SCEDC, NCEDC, CEED, and contributing-network sources as appropriate."
+title: "SeismicX-Cont: a coverage-aware HDF5 continuous-waveform data product for deployment-level earthquake monitoring"
 version: "v1.0.0"
 date-released: "2026-05-31"
 type: dataset
+doi: "10.57967/hf/9002"
+abstract: "Processed and structured HDF5-based continuous-waveform database for non-commercial scientific research. Licensing is layer-specific: waveform-derived HDF5 products are distributed under upstream-compatible source-provider terms, SeismicX-Cont-authored metadata and documentation are CC BY 4.0, and code is MIT."
 authors:
   - family-names: Yu
     given-names: Ziye
@@ -22,6 +24,12 @@ authors:
 repository-code: "https://huggingface.co/datasets/cangyeone/SeismicX-Cont"
 url: "https://www.modelscope.cn/datasets/cangyeone/SeismicX-Cont"
 identifiers:
+  - type: doi
+    value: "10.57967/hf/9002"
+    description: "Full SeismicX-Cont v1.0.0 release DOI"
+  - type: doi
+    value: "10.5281/zenodo.20047415"
+    description: "SeismicX-Cont Mini Two-Hour Subset v1.0.0-mini DOI"
   - type: url
     value: "https://huggingface.co/datasets/cangyeone/SeismicX-Cont"
     description: "Full SeismicX-Cont release on Hugging Face"
@@ -34,4 +42,3 @@ keywords:
   - phase picking
   - earthquake monitoring
   - HDF5
-license: CC-BY-4.0

LICENSE_CLARIFICATION.md

@@ -0,0 +1,47 @@
+# SeismicX-Cont License and Data-Use Clarification
+
+SeismicX-Cont is a processed and structured HDF5-based continuous-waveform data
+product. It is derived from source waveform archives and event metadata, but it
+does not reproduce the original NCEDC or SCEDC archive organization and it is
+not an official waveform archive or network catalog.
+
+## Layer-specific terms
+
+| Release layer | Terms |
+| --- | --- |
+| Processed HDF5 waveform database products in `data/hdf5/` and waveform-derived mini subsets | Distributed for non-commercial scientific research under upstream-compatible source-provider terms, including NCEDC-compatible CC BY-NC 4.0 conditions where applicable. The waveform arrays are not relicensed by SeismicX-Cont under CC BY 4.0. |
+| SeismicX-Cont-authored metadata schemas, documentation, manifests, validation summaries, figures, and reuse documentation | Creative Commons Attribution 4.0 International (CC BY 4.0). |
+| Source code in `scripts/`, `essd_scripts/`, `utils/`, and notebooks | MIT License. |
+| CEED-derived event and phase annotations | Distributed with source lineage retained. Users should cite SeismicX-Cont and the original CEED, SCEDC, NCEDC, and contributing-network sources as appropriate. |
+| Optional automatic-pick outputs and consensus-candidate files | Validation and interoperability products. They are not ground truth and should be used with the same source-provider attribution and data-use constraints as the corresponding waveform-derived products. |
+
+## Provider clarification
+
+Publication and redistribution of the processed HDF5 waveform layer have been
+clarified with the relevant U.S. seismic data providers. The release is intended
+for non-commercial scientific research, with documented preprocessing,
+transformation steps, HDF5 schema, metadata fields, and waveform-database
+construction procedures. The repository does not include provider-email text,
+dates, or quotations as part of the public license file.
+
+## Citation and reuse requirements
+
+Users should cite the SeismicX-Cont full data-product DOI, the mini subset DOI
+when using the two-hour archive, and the original source data providers:
+SCEDC, NCEDC, CEED, and contributing seismic networks as appropriate.
+
+Full release:
+
+- Hugging Face: https://huggingface.co/datasets/cangyeone/SeismicX-Cont
+- DOI: https://doi.org/10.57967/hf/9002
+- ModelScope mirror: https://www.modelscope.cn/datasets/cangyeone/SeismicX-Cont
+
+Mini subset:
+
+- Zenodo record: https://zenodo.org/records/20047415
+- DOI: https://doi.org/10.5281/zenodo.20047415
+
+Users must consult and comply with applicable source-provider data-use terms
+before redistributing, modifying, or using waveform-derived products in a new
+context. SeismicX-Cont does not replace the authoritative SCEDC or NCEDC
+waveform archives or the CEED source products.

README.md

@@ -2,7 +2,13 @@
 language:
 - en
 
-license: cc-by-4.0
+license: other
+license_name: layered-upstream-compatible-terms
+license_details: >
+  Waveform-derived HDF5 database products are distributed for non-commercial
+  scientific research under upstream-compatible source-provider terms.
+  SeismicX-Cont-authored metadata, documentation, manifests, validation
+  summaries, and figures are CC BY 4.0; code is MIT.
 
 tags:
 - seismology
@@ -16,7 +22,7 @@ tags:
 - seismic-event-detection
 - phase-picking
 
-pretty_name: SeismicX-Cont — Continuous Seismic Dataset
+pretty_name: SeismicX-Cont — HDF5 Continuous-Waveform Data Product
 
 size_categories:
 - 100GB<n<1TB
@@ -30,8 +36,8 @@ configs:
 dataset_info:
   features: {}
   description: |
-    Continuous seismic waveform dataset for benchmarking seismic monitoring and phase picking models.
-    Includes multi-station continuous recordings, metadata, and event annotations.
+    Processed and structured HDF5-based continuous-waveform data product for deployment-level earthquake monitoring.
+    Includes continuous waveform database files, coverage metadata, annotations, response metadata, validation scripts, and reuse documentation.
 
 ---
 
@@ -39,19 +45,26 @@ dataset_info:
   <img src="logo.png" alt="SeismicX logo" width="180"/>
 </p>
 
-<h1 align="center">SeismicX-Cont — Continuous Seismic Dataset</h1>
+<h1 align="center">SeismicX-Cont — HDF5 Continuous-Waveform Data Product</h1>
 
 <p align="center">
-  Benchmark dataset for seismic monitoring with continuous waveform data
+  Processed continuous-waveform database for deployment-level earthquake monitoring
 </p>
 
 ## 1. Overview
 
-The **SeismicX-Continuous Dataset** is a curated benchmark dataset optimized for evaluating seismic monitoring algorithms on real-world **continuous waveform recordings**.
+**SeismicX-Cont** is a processed and structured HDF5-based continuous-waveform
+data product for deployment-level earthquake-monitoring studies.
 
-Unlike traditional event-driven datasets, this collection emphasizes **continuous data streams**, enabling robust comparisons across both **high-activity** and **low-activity** seismic periods.
+The release preserves continuous waveform context, station-time coverage,
+annotation provenance, instrument-response metadata, and validation lineage in a
+common file organization. It is intended as a reusable monitoring data product,
+not as a relative model-assessment resource or a replacement for the
+authoritative SCEDC, NCEDC, or CEED source archives.
 
-The dataset is integrated with the **SeismicX DataLoader**, delivering an **AI-ready pipeline** for large-scale waveform analysis.
+The repository includes the **SeismicX DataLoader**, SQLite coverage-query
+utilities, validation scripts, and quick-start notebooks for reproducible
+access to the released files.
 
 ---
 
@@ -87,8 +100,13 @@ Release metadata and integrity files:
 
 - `VERSION` records the release version (`v1.0.0`).
 - `CITATION.cff` provides machine-readable citation metadata.
+- `LICENSE_CLARIFICATION.md` explains the layer-specific data-use terms.
 - `manifest_sha256.txt` lists release-file SHA-256 checksums.
 - `manifest_filesizes.tsv` lists release-file sizes in bytes.
+- Full release DOI: https://doi.org/10.57967/hf/9002
+- Mini two-hour subset DOI: https://doi.org/10.5281/zenodo.20047415
+- Public mirrors: https://huggingface.co/datasets/cangyeone/SeismicX-Cont and
+  https://www.modelscope.cn/datasets/cangyeone/SeismicX-Cont
 
 Recommended quickstart and reproducibility order:
 
@@ -147,17 +165,25 @@ The dataset includes continuous three-component waveform data in HDF5 format, st
 
 ---
 
-## 3. Benchmark Design
+## 3. Monitoring-Period Design
 
-SeismicX-Continuous is designed as a **dual-scenario benchmark**, separating the dataset into high- and low-activity evaluation regimes.
+SeismicX-Cont pairs two one-week monitoring periods in the same HDF5,
+annotation, response, and coverage-index structure. The paired design supports
+reusable continuous-stream validation under contrasting monitoring conditions.
 
 ### 3.1 High-Activity Window (July 2019)
 
-Dense seismicity with frequent and overlapping events. Evaluation focuses on recall, missed detections, detection in clustered event sequences, and temporal resolution limits.
+Dense seismicity with frequent and overlapping events. Reuse typically focuses
+on coverage-qualified recall, phase-time residuals, station coverage, and the
+ability to inspect workflow behavior during clustered earthquake sequences.
 
 ### 3.2 Low-Activity Window (November 2021)
 
-Sparse seismicity with extended quiet periods. Evaluation focuses on precision, false alarms, noise robustness, and model stability over long quiet intervals.
+Sparse seismicity with extended quiet periods relative to the Ridgecrest week.
+Reuse typically focuses on catalog-unmatched automatic-pick burden, noise
+conditions, station availability, and reporting stability over long continuous
+intervals. Catalog-unmatched picks should not be interpreted automatically as
+confirmed false detections.
 
 ---
 
@@ -544,35 +570,45 @@ Sample output:
 
 ---
 
-## 6. Evaluation Metrics
+## 6. Recommended Reporting Quantities
 
-Recommended metrics for benchmarking models on this dataset:
+Recommended reporting quantities for reusable continuous-monitoring studies:
 
-- Recall (Detection Rate) — fraction of labeled picks matched within the TP tolerance
-- Precision — fraction of automatic picks that correspond to a labeled event
+- Coverage-aware recall — fraction of waveform-covered reference arrivals matched within the TP tolerance
+- Reference-catalog matched fraction — fraction of automatic picks that correspond to a labeled event in the reference catalog
 - F1-score — harmonic mean of precision and recall
 - Miss Rate — 1 − Recall
-- False Alarm Rate — automatic picks per unit time with no matching label
+- Catalog-unmatched pick rate — automatic picks per unit time with no matching reference label
 - Residual distribution — mean, std, and robust percentiles of `auto_time − label_time`
 
 ---
 
-## 7. Design Philosophy
+## 7. Data-Product Rationale
 
-SeismicX-Continuous is built as a **controlled benchmark for continuous seismic monitoring**, with separate evaluation pathways for:
+SeismicX-Cont is organized as a reusable continuous-monitoring data product
+with separate reporting views for:
 
-- High-event-density conditions → missed detection analysis
-- Low-event-density conditions → false alarm and stability analysis
+- high-event-density conditions, where waveform coverage and reference-label
+  denominators must be documented carefully;
+- lower-event-rate background conditions, where catalog-unmatched automatic
+  picks, station coverage, and metadata completeness become prominent.
 
-This structure supports systematic evaluation of model behavior in realistic operational scenarios.
+The structure supports reproducible reporting and workflow diagnostics without
+implying a standardized or fair comparison among independently trained picking
+systems.
 
 ---
 
 ## 8. Summary
 
-The SeismicX-Continuous Dataset provides a realistic continuous waveform benchmark, balanced evaluation scenarios, high-quality annotations, and an AI-ready data structure.
+SeismicX-Cont provides a processed continuous waveform database, coverage
+metadata, CEED-derived annotations, instrument-response metadata, validation
+scripts, and reusable access utilities.
 
-It is well suited for continuous seismic detection, real-time monitoring systems, machine learning model evaluation, and large-scale waveform analysis.
+It is well suited for continuous seismic detection studies, monitoring-workflow
+diagnostics, phase-association experiments, and large-scale waveform analysis
+where provenance, coverage, and source-provider attribution must remain
+auditable.
 
 ---
 
@@ -886,7 +922,7 @@ Each output line is a self-contained JSON record. Two `record_type` values are w
 Compares automatically generated phase picks against human annotation labels. Uses a SQLite index to handle JSONL output files of 40 GB or more without loading them into memory.
 The baseline outputs distributed with the release are usability validation and
 interoperability checks for the data product and reporting scripts. They are not
-a model-performance ranking or leaderboard.
+relative model-assessment evidence.
 
 ---
 
@@ -1107,7 +1143,8 @@ python essd_scripts/compare_associated_events.py \
 
 An event is counted as a true positive when it matches a reference event with
 epicentral distance error `< 20 km` and origin-time error `< 3 s`. The script
-reports event precision, recall, F1, false positives, false negatives, and
+reports event precision, recall, F1, apparent false positives and false
+negatives relative to the reference catalog, and
 time/location/depth/magnitude error statistics. The generic event JSONL format
 is documented in `essd_scripts/README_event_comparison.md`.
 
@@ -1115,12 +1152,23 @@ is documented in `essd_scripts/README_event_comparison.md`.
 
 ## 13. License, Citation, and Checksums
 
-Data products and derived metadata are released under **CC BY 4.0**. Code is
-released under the **MIT License**. See `LICENSE` for the full terms.
-
-The waveform data remain subject to the original SCEDC and NCEDC data usage
-policies. When reusing SeismicX-Cont, cite SeismicX-Cont together with the
-original SCEDC, NCEDC, and CEED sources.
+Licensing is layer-specific. See `LICENSE` and `LICENSE_CLARIFICATION.md` for
+the full terms.
+
+- Waveform-derived HDF5 database products are processed and structured
+  derivatives of source waveform records. Publication and redistribution of this
+  processed HDF5 waveform layer have been clarified with the relevant U.S.
+  seismic data providers, and use is limited to non-commercial scientific
+  research under upstream-compatible data-use terms.
+- SeismicX-Cont-authored metadata schemas, documentation, manifests, validation
+  summaries, figures, and reuse documentation are released under **CC BY 4.0**.
+- Code in `scripts/`, `essd_scripts/`, `utils/`, and notebooks is released
+  under the **MIT License**.
+
+The waveform arrays in the HDF5 products are not relicensed by SeismicX-Cont
+under CC BY 4.0. Users must comply with source-provider terms and cite
+SeismicX-Cont together with the original SCEDC, NCEDC, CEED, and contributing
+network sources as appropriate.
 
 The release version is recorded in `VERSION`; releases should also be tagged
 with the same version string, for example `v1.0.0`. Machine-readable citation

README.zh.md

@@ -2,19 +2,23 @@
   <img src="logo.png" alt="SeismicX logo" width="180"/>
 </p>
 
-<h1 align="center">SeismicX-Cont — 连续地震数据集</h1>
+<h1 align="center">SeismicX-Cont — HDF5 连续波形数据产品</h1>
 
 <p align="center">
-  用于连续波形地震监测的基准数据集
+  面向部署级地震监测的结构化连续波形数据库
 </p>
 
 ## 1. 概述
 
-**SeismicX-Continuous 数据集** 是一个精心构建的基准数据集，旨在评估真实世界持续波形记录条件下的地震监测算法。
+**SeismicX-Cont** 是一个经过处理和结构化组织的 HDF5 连续波形数据产品，
+用于支持部署级地震监测研究。
 
-与传统的事件驱动数据集不同，本数据集强调**连续数据流**，支持对高活动和低活动地震时段的稳健比较。
+该发布包在统一文件结构中保留连续波形、台站-时间覆盖、标注来源、仪器响应元数据
+和验证流程。它是可复用的监测数据产品，不是相对模型评估资源，也不替代权威的
+SCEDC、NCEDC 或 CEED 源数据档案。
 
-该数据集与 **SeismicX DataLoader** 集成，为大规模波形分析提供了一个**AI 就绪流水线**。
+仓库同时提供 **SeismicX DataLoader**、SQLite 覆盖查询工具、验证脚本和
+quick-start notebook，便于对发布文件进行可复现访问。
 
 ---
 
@@ -45,8 +49,13 @@ coverage、连续输出诊断、consensus audit 和 appendix 表格数值。
 
 - `VERSION` 记录发布版本（`v1.0.0`）。
 - `CITATION.cff` 提供机器可读引用元数据。
+- `LICENSE_CLARIFICATION.md` 说明分层许可和数据使用边界。
 - `manifest_sha256.txt` 记录发布文件的 SHA-256 校验值。
 - `manifest_filesizes.tsv` 记录发布文件大小（字节）。
+- 完整发布 DOI：https://doi.org/10.57967/hf/9002
+- 两小时 mini 子集 DOI：https://doi.org/10.5281/zenodo.20047415
+- 公开镜像：https://huggingface.co/datasets/cangyeone/SeismicX-Cont 和
+  https://www.modelscope.cn/datasets/cangyeone/SeismicX-Cont
 
 推荐 quickstart 和复现脚本顺序：
 
@@ -101,17 +110,21 @@ TIME_WINDOWS = [
 
 ---
 
-## 3. 基准设计
+## 3. 监测时段设计
 
-SeismicX-Continuous 设计为一个**双场景基准**，将数据集划分为高活动和低活动两种评估环境。
+SeismicX-Cont 将两个一周长的监测时段放在同一套 HDF5、annotation、
+response 和 coverage-index 结构中，便于在不同监测条件下复用连续数据流。
 
 ### 3.1 高活动窗口（2019 年 7 月）
 
-地震活动密集，事件频繁且可能重叠。评估重点为召回率与漏检、聚集事件下的检测能力和时间分辨率限制。
+该时段地震活动密集，事件频繁且可能重叠。复用时通常关注 coverage-qualified
+recall、震相残差、台站覆盖，以及密集地震序列中的工作流行为。
 
 ### 3.2 低活动窗口（2021 年 11 月）
 
-地震活动稀疏，长时间静默期。评估重点为精度与误报率、噪声鲁棒性和模型在长静默期间的稳定性。
+该时段相对于 Ridgecrest 周为低活动背景。复用时通常关注 catalog-unmatched
+automatic-pick burden、噪声条件、台站可用性和长连续时段内的报告稳定性。
+未匹配参考目录的自动拾取不应自动解释为确认的错误检测。
 
 ---
 
@@ -495,33 +508,37 @@ python scripts/example_dataloader.py \
 
 ---
 
-## 6. 评估指标
+## 6. 推荐报告量
 
-推荐使用以下指标对本数据集上的模型进行基准测试：
+推荐在连续监测复用研究中至少报告以下量：
 
-- 召回率（检测率）— 在 TP 容限时间窗内匹配到的标注震相比例
-- 精度 — 自动拾取中对应真实事件的比例
+- coverage-aware recall — 在 TP 容限时间窗内匹配到的、有波形覆盖的参考震相比例
+- reference-catalog matched fraction — 自动拾取中可匹配参考目录标注的比例
 - F1 分数 — 精度与召回率的调和平均
 - 漏检率 — 1 − 召回率
-- 误报率 — 单位时间内无对应标注的自动拾取数量
+- catalog-unmatched pick rate — 单位时间内未匹配参考标注的自动拾取数量
 - 残差分布 — `auto_time − label_time` 的均值、标准差和稳健百分位数
 
 ---
 
-## 7. 设计理念
+## 7. 数据产品设计理念
 
-SeismicX-Continuous 作为一个**连续地震监测的受控基准**，在不同条件下区分评估：
+SeismicX-Cont 作为一个可复用的连续监测数据产品，提供不同条件下的报告视角：
 
-- 高频事件密度 → 漏检分析
-- 低频事件密度 → 误报与稳定性分析
+- 高频事件密度条件下，需要谨慎记录波形覆盖和参考标注分母；
+- 低事件率背景条件下，catalog-unmatched 自动拾取、台站覆盖和元数据完整性更加突出。
 
-这种结构有助于系统性评估模型在真实运行场景中的行为。
+这种结构支持可复现报告和工作流诊断，但不意味着对独立训练的拾取系统进行
+标准化或公平的模型比较。
 
 ---
 
 ## 8. 总结
 
-SeismicX-Continuous 数据集提供了真实的连续波形基准、平衡的评估场景、高质量标注和 AI 就绪数据结构，特别适合用于连续地震检测、实时监测系统、机器学习模型评估和大规模波形分析。
+SeismicX-Cont 提供处理后的连续波形数据库、覆盖元数据、CEED 衍生标注、
+仪器响应元数据、验证脚本和可复用访问工具。它适合用于连续地震检测研究、
+监测工作流诊断、震相关联实验和需要保留 provenance、coverage 与源数据引用边界的
+大规模波形分析。
 
 ---
 
@@ -824,7 +841,7 @@ done
 ## 11. 拾取评估：`essd_scripts/evaluate_picks.py`
 
 将自动生成的震相拾取结果与人工标注标签进行对比，使用 SQLite 索引高效处理 40 GB 以上的 JSONL 文件。
-随发布包给出的 baseline 输出用于数据产品可用性验证和格式互操作检查，不是模型性能排名或 leaderboard。
+随发布包给出的 baseline 输出用于数据产品可用性验证和格式互操作检查，不是相对模型评估证据。
 
 ---
 
@@ -1038,19 +1055,27 @@ python essd_scripts/compare_associated_events.py \
 ```
 
 当关联事件与参考目录事件满足震中距误差 `< 20 km` 且发震时刻误差 `< 3 s`
-时，计为一个 TP 地震样本。脚本输出事件级 precision、recall、F1、误报事件、
-漏检事件，以及时间、位置、深度和震级误差统计。通用 event JSONL 格式见
+时，计为一个 TP 地震样本。脚本输出事件级 precision、recall、F1、相对于参考目录的
+apparent false positives 和 false negatives，以及时间、位置、深度和震级误差统计。通用 event JSONL 格式见
 `essd_scripts/README_event_comparison.md`。
 
 ---
 
 ## 13. 许可、引用与校验清单
 
-数据产品和衍生元数据采用 **CC BY 4.0** 发布。代码采用 **MIT License**
-发布。完整条款见 `LICENSE`。
+许可按发布层分开说明。完整条款见 `LICENSE` 和 `LICENSE_CLARIFICATION.md`。
 
-波形数据仍受原始 SCEDC 和 NCEDC 数据使用政策约束。复用 SeismicX-Cont
-时，除引用 SeismicX-Cont 外，也应引用原始 SCEDC、NCEDC 和 CEED 数据来源。
+- HDF5 波形数据库产品是由源波形记录处理和结构化得到的衍生产品。该处理后
+  HDF5 波形层的发表和再分发已与相关美国地震数据提供方澄清，使用范围限于
+  非商业科学研究，并遵循与上游兼容的数据使用条款。
+- SeismicX-Cont 作者生成的元数据 schema、文档、manifest、验证摘要、图件和
+  复用说明采用 **CC BY 4.0**。
+- `scripts/`、`essd_scripts/`、`utils/` 和 notebooks 中的代码采用
+  **MIT License**。
+
+HDF5 产品中的波形数组不由 SeismicX-Cont 重新授权为 CC BY 4.0。用户必须遵守
+源数据提供方条款，并在适当情况下同时引用 SeismicX-Cont、SCEDC、NCEDC、
+CEED 和贡献台网来源。
 
 发布版本记录在 `VERSION` 中；正式发布时也应使用相同版本号作为 tag，例如
 `v1.0.0`。机器可读引用元数据见 `CITATION.cff`。