onescience_manifest_version: "0.1"
resource_type: dataset
resource:
  id: OneScience/ani1x
  name: ANI-1x
  domain: matchem
  domain_tags:
    - matchem
    - molecular_dataset
    - atomistic_simulation
  task: mlip_training_data
  task_tags:
    - mlip
    - energy_prediction
    - force_prediction
  modalities:
    - atomistic_structure
  input_formats:
    - hdf5
    - extxyz
  output_formats: []
  summary: 面向 MACE 训练和评测的 ANI-1x 分子构型数据集标准包。

platform_resource:
  primary:
    platform: modelscope
    repo_id: OneScience/ani1x
    repo_type: dataset
    url: https://modelscope.cn/datasets/OneScience/ani1x
    revision: main
    readme_path: README.md
    manifest_path: manifest.yaml
  mirrors: []
  access:
    visibility: public
    license: null

website_integration:
  enabled: true
  click_target:
    platform: modelscope
    resource_url: https://modelscope.cn/datasets/OneScience/ani1x
  llm_handoff:
    readme_required: true
    manifest_required: true
    download_readme_first: true
    resolve_related_models: true
    default_run_goal: minimal_validation

runtime:
  enabled: true
  onescience_domain: matchem
  min_onescience_version: null
  supported_execution:
    - local
    - local_slurm
    - remote_slurm
    - scnet_mcp

onescience:
  repo: https://gitee.com/onescience-ai/onescience
  official_links:
    gitee:
      doc: https://gitee.com/onescience-ai/onescience-doc
      onescience: https://gitee.com/onescience-ai/onescience
      skills: https://gitee.com/onescience-ai/oneskills
    github:
      doc: https://github.com/onescience-ai/OneScience-doc
      onescience: https://github.com/onescience-ai/OneScience
      skills: https://github.com/onescience-ai/oneskills
  install:
    required_by_default: false
    command: bash install.sh matchem
  source_paths:
    - matchem/mace/ani1x
  compatibility:
    examples_path: examples/matchem/mace
    status: examples_compatible

runtime_package:
  kind: standard_runtime_package
  package_root: .
  standard_layout:
    workdir: .
    config_dir: metadata
    checkpoint_dir: null
    data_dir: data
    output_dir: outputs
  apply_policy:
    mode: direct_use
    target: session_workdir
    overwrite: true
    protect_installed_onescience: true
  entry_files:
    - scripts/validate_ani1x.py
    - metadata/schema.yaml
    - metadata/sha256_manifest.txt
  entrypoints:
    preflight: scripts/validate_ani1x.py
    inference: null
    train: null
    finetune: null
    evaluate: null
    visualize: null
    deploy: null

files:
  model_files: []
  dataset_files:
    - id: ani1x_train_h5
      path: data/ani1x/ANI1x_cc_DFT_rc5_train/
      role: train_split
      description_zh: ANI-1x 训练集 HDF5 分片目录，共 8 个 train_*.h5 文件。
      required: true
      required_for: [preflight, train]
      format: hdf5
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: data/ani1x/ANI1x_cc_DFT_rc5_train/
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/data/ani1x/ANI1x_cc_DFT_rc5_train/
      size: 22M
      checksum: metadata/sha256_manifest.txt
      large_file: false
    - id: ani1x_val_h5
      path: data/ani1x/ANI1x_cc_DFT_rc5_val/
      role: validation_split
      description_zh: ANI-1x 验证集 HDF5 分片目录，共 8 个 val_*.h5 文件。
      required: true
      required_for: [preflight, train, evaluate]
      format: hdf5
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: data/ani1x/ANI1x_cc_DFT_rc5_val/
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/data/ani1x/ANI1x_cc_DFT_rc5_val/
      size: 728K
      checksum: metadata/sha256_manifest.txt
      large_file: false
    - id: ani1x_test_h5
      path: data/ani1x/ANI1x_cc_DFT_rc5_test/
      role: test_split
      description_zh: ANI-1x 测试集 HDF5 分片目录，共 8 个 Default__*.h5 文件。
      required: true
      required_for: [preflight, evaluate]
      format: hdf5
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: data/ani1x/ANI1x_cc_DFT_rc5_test/
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/data/ani1x/ANI1x_cc_DFT_rc5_test/
      size: 12M
      checksum: metadata/sha256_manifest.txt
      large_file: false
    - id: ani1x_statistics
      path: data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
      role: statistics
      description_zh: MACE 训练需要的原子能量、邻居数、均值、标准差和 r_max 统计文件。
      required: true
      required_for: [preflight, train, evaluate]
      format: json
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
      size: 512B
      checksum: metadata/sha256_manifest.txt
      large_file: false
    - id: ani1x_xyz
      path: data/ani1x/*.xyz
      role: metadata
      description_zh: ANI-1x 的 extxyz 版本和 train/test 辅助文件，可用于人工检查或其他工具读取。
      required: false
      required_for: [preflight]
      format: extxyz
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: data/ani1x/*.xyz
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/data/ani1x/*.xyz
      size: 728M
      checksum: metadata/sha256_manifest.txt
      large_file: false
  config_files:
    - id: schema
      path: metadata/schema.yaml
      role: schema
      description_zh: 数据 split、HDF5 字段、dtype、shape、单位和统计文件说明。
      required: true
      required_for: [preflight, train, evaluate]
      format: yaml
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: metadata/schema.yaml
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/metadata/schema.yaml
      size: null
      checksum: null
      large_file: false
    - id: sha256_manifest
      path: metadata/sha256_manifest.txt
      role: checksum
      description_zh: 数据文件 SHA256 清单，用于校验整理后数据与原始数据一致。
      required: true
      required_for: [preflight]
      format: txt
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: metadata/sha256_manifest.txt
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/metadata/sha256_manifest.txt
      size: null
      checksum: null
      large_file: false
  sample_files:
    - id: validate_script
      path: scripts/validate_ani1x.py
      role: script
      description_zh: 数据读取验证脚本，检查文件结构、shape、dtype、statistics 和 SHA256。
      required: true
      required_for: [preflight]
      format: py
      source:
        platform: modelscope
        repo_id: OneScience/ani1x
        repo_type: dataset
        path: scripts/validate_ani1x.py
        revision: main
        url: null
        download_method: command_ref
        command_ref: commands.download.download_dataset_package
      mirrors: []
      local_path: session_workdir/scripts/validate_ani1x.py
      size: null
      checksum: null
      large_file: false

dataset:
  format:
    - hdf5
    - extxyz
  sample_unit: 单个分子构型，包含原子序数、坐标、cell、pbc、能量和原子受力。
  schema:
    path: metadata/schema.yaml
  splits:
    train:
      path: data/ani1x/ANI1x_cc_DFT_rc5_train
      shards: 8
    validation:
      path: data/ani1x/ANI1x_cc_DFT_rc5_val
      shards: 8
    test:
      path: data/ani1x/ANI1x_cc_DFT_rc5_test
      shards: 8

relations:
  required_datasets: []
  optional_datasets: []
  compatible_models:
    - id: OneScience/MACE
      role: train_data
      required_for: [preflight, train, evaluate]
      resource_ref:
        platform: modelscope
        repo_id: OneScience/MACE
        repo_type: model
        url: https://modelscope.cn/models/OneScience/MACE
        revision: main
        readme_path: README.md
        manifest_path: manifest.yaml
      expected_local_path: session_workdir/data/ani1x
      adapter: null

run_matrix:
  scenarios:
    - name: validate_dataset
      default: true
      capability: preflight
      required_datasets:
        - id: OneScience/ani1x
          role: train_data
          local_path: data/ani1x
      required_model_files: []
      required_data_files:
        - data/ani1x/ANI1x_cc_DFT_rc5_train/*.h5
        - data/ani1x/ANI1x_cc_DFT_rc5_val/*.h5
        - data/ani1x/ANI1x_cc_DFT_rc5_test/*.h5
        - data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
        - metadata/sha256_manifest.txt
      preconditions:
        - 已下载数据集仓库 OneScience/ani1x。
      command_refs:
        - commands.preflight.validate_dataset
      outputs:
        - path: stdout
          description_zh: 数据结构、统计文件和 SHA256 检查结果。

capabilities:
  inference: false
  train: false
  finetune: false
  evaluate: false
  visualize: false
  deploy: false

commands:
  download:
    - name: download_dataset_package
      target: dataset
      repo_id: OneScience/ani1x
      source: .
      local_path: session_workdir/
      required: true
      required_for: [preflight, train, evaluate]
      cwd: .
      command: modelscope download --dataset OneScience/ani1x --local_dir session_workdir
      expected_outputs:
        - path: session_workdir/data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
          type: file
      success_criteria:
        - exit_code == 0
        - output_path_exists
  preflight:
    - name: validate_dataset
      description: 验证 ANI-1x 文件结构、HDF5 schema、statistics 和 SHA256。
      cwd: .
      command: python scripts/validate_ani1x.py --dataset-root data/ani1x --checksum-manifest metadata/sha256_manifest.txt
      required_files:
        - data/ani1x/ANI1x_cc_DFT_rc5_statistics.json
        - metadata/sha256_manifest.txt
        - scripts/validate_ani1x.py
      required_env:
        - python
        - h5py
      expected_outputs:
        - path: stdout
          type: text
      success_criteria:
        - exit_code == 0
  prepare: []
  inference: []
  train: []
  finetune: []
  evaluate: []
  visualize: []
  deploy: []

expected_outputs:
  - path: stdout
    type: text
    description_zh: 验证脚本输出每个 split、statistics 和 SHA256 的 OK 结果。

diagnostics:
  - error_pattern: "缺少文件"
    likely_cause: 数据集下载不完整或本地路径错误。
    action: 重新执行 modelscope download --dataset OneScience/ani1x，并确认运行 cwd 是数据集仓库根目录。
  - error_pattern: "SHA256 不一致"
    likely_cause: 文件被截断、损坏或被替换。
    action: 删除损坏文件后重新下载数据集。
  - error_pattern: "HDF5"
    likely_cause: HDF5 文件损坏或 schema 与 MACE 预期不一致。
    action: 运行 scripts/validate_ani1x.py 定位具体文件，并与 metadata/schema.yaml 对照。
  - error_pattern: "ModuleNotFoundError"
    likely_cause: 缺少 h5py 或 Python 环境未配置。
    action: 安装 h5py，或执行 bash install.sh matchem。

domain_extension:
  matchem:
    chemical_system:
      elements:
        - H
        - C
        - N
        - O
    properties:
      - energy
      - forces
    units:
      energy: eV
      forces: eV/Angstrom
    structure_format:
      - hdf5
      - extxyz

large_resource:
  enabled: false
  total_size: 762M
  file_count: 28
  download_policy: full
  default_download: full
  minimal_files:
    - data/ani1x/ANI1x_cc_DFT_rc5_train/train_0.h5
    - data/ani1x/ANI1x_cc_DFT_rc5_val/val_0.h5
    - data/ani1x/ANI1x_cc_DFT_rc5_test/Default__0.h5
    - data/ani1x/ANI1x_cc_DFT_rc5_statistics.json

reproducibility:
  level: minimal
  goal: 完成一次数据读取和 SHA256 校验。
  command_ref: commands.preflight.validate_dataset
  expected_runtime: 1-5 minutes
  expected_outputs:
    - stdout