chem-db-mof
Query multiple MOF databases (QMOF via MPContribs; ARC-MOF DB7/Majumdar et al. via Zenodo) and download CIF structures with optional element or identifier filters.
learningmatter-mit · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add learningmatter-mit/AtomisticSkills --skill chem-db-mof技能说明
name: chem-db-mof description: Query multiple MOF databases (QMOF via MPContribs; ARC-MOF DB7/Majumdar et al. via Zenodo) and download CIF structures with optional element or identifier filters. category: chemistry
chem-db-mof
Goal
Provide a unified interface for retrieving Metal-Organic Framework (MOF) crystal structures from multiple curated databases. Currently supported:
| Database | Alias | Size | Access | Structures |
|---|---|---|---|---|
| Quantum MOF (QMOF) | qmof | ~20,000 DFT-relaxed | MPContribs API | DFT-optimized CIFs + bandgaps |
| ARC-MOF DB7 (Majumdar et al.) | arcmof-majumdar | 12,316 hypothetical | Zenodo stream | CIFs with REPEAT partial charges |
Prerequisites
- Environment:
base-agent - Packages:
mpcontribs-client,requests,pandas,pymatgen - Credentials:
MP_API_KEYenvironment variable (required forqmofonly)
Instructions
Step 1: Choose a database and set filters
Decide which database to query and which element/identifier filters to apply.
For QMOF — best for DFT-validated, experimentally-derived MOFs:
- Use
--formulafor element filtering (e.g.,ZnorCu,N,O) - Use
--identifierfor a specific CSD refcode (e.g.,KAXQIL)
For ARC-MOF DB7 (Majumdar et al.) — best for diverse hypothetical MOFs with underrepresented inorganic SBUs:
- Use
--elementsfor element filtering (e.g.,Zn,O,C) - Use
--identifierfor a specific structure ID (e.g.,DB7_00042) - First run: downloads
geometric_properties.csv(~110 MB) to~/.cache/arcmof/— one-time only; subsequent runs are fast
Step 2: Run the query
# Env: base-agent
# QMOF — 10 Zn-containing MOFs
MP_API_KEY=<your_key> python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database qmof \
--formula Zn \
--max-results 10 \
--output-dir ./research/<date>_<task>/structures/qmof
# Env: base-agent
# ARC-MOF DB7 (Majumdar) — 20 Zn,O,C hypothetical MOFs
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database arcmof-majumdar \
--elements Zn,O,C \
--max-results 20 \
--output-dir ./research/<date>_<task>/structures/arcmof_db7
# Env: base-agent
# ARC-MOF DB7 — retrieve a specific structure by identifier
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database arcmof-majumdar \
--identifier DB7_00042 \
--output-dir ./research/<date>_<task>/structures/arcmof_db7
Available Arguments
| Argument | Applies to | Description |
|---|---|---|
--database | both | qmof or arcmof-majumdar |
--formula | qmof | Element/formula filter string (e.g., Zn,O,C) |
--elements | arcmof-majumdar | Comma-separated required elements; ALL must be present |
--identifier | both | Specific structure name or ID substring |
--max-results | both | Max CIFs to download (default: 10) |
--output-dir | both | Directory for output CIF files |
--cache-dir | arcmof-majumdar | Override default cache ~/.cache/arcmof/ |
Step 3: Inspect outputs
The script saves:
- Individual
.ciffiles named by structure identifier arcmof_db7_metadata.csv(ARC-MOF only) — geometric properties for the downloaded subset
Verify the download:
ls -lh <output-dir>/*.cif | head -20
Download Behavior: ARC-MOF DB7
The first call with --database arcmof-majumdar performs:
- Metadata download (~110 MB, one-time):
geometric_properties.csvcached at~/.cache/arcmof/ - DB7 filtering: identifies the 12,316 Majumdar structures from the full 288k-entry CSV
- CIF streaming: streams the ARC-MOF tarball (
ARCMOF_20241004.tar.gz, ~670 MB) and extracts only the requested CIFs — the stream is read once but only matching files are written to disk
Subsequent runs with the same --output-dir skip already-downloaded CIFs.
Examples
Example 1: Query Zn MOFs from QMOF for CO₂ screening pre-processing
# Env: base-agent
MP_API_KEY=<your_mp_api_key> \
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database qmof \
--formula Zn \
--max-results 10 \
--output-dir ./research/2026-03-27_test/qmof_zn
Example 2: Query Zn, Ni, or Mg hypothetical MOFs from ARC-MOF DB7
# Env: base-agent
# Zn-based
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database arcmof-majumdar \
--elements Zn,O,C \
--max-results 50 \
--output-dir ./research/2026-03-27_arcmof_zn
# Ni-based
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database arcmof-majumdar \
--elements Ni,O,C \
--max-results 50 \
--output-dir ./research/2026-03-27_arcmof_ni
# Mg-based
python .agents/skills/chem-db-mof/scripts/query_mof_db.py \
--database arcmof-majumdar \
--elements Mg,O,C \
--max-results 50 \
--output-dir ./research/2026-03-27_arcmof_mg
Tip: You can expand diversity by adding more elements to
--elements(e.g.,Zn,Ni,O,C,Nto retrieve MOFs containing all of those elements simultaneously), or run separate queries per metal node and combine the resulting CIF directories for a broader screening campaign.
Constraints
- API limits: QMOF via MPContribs has rate limits; keep
--max-results≤ 100 per call. - ARC-MOF first-run time: Downloading the metadata CSV (~110 MB) takes ~1–2 min; streaming the tarball for CIF extraction adds ~5–15 min depending on how many structures are requested and network speed.
- ARC-MOF CIF fallback: If some DB7 structures are not found in
ARCMOF_20241004.tar.gz, they may reside inall_structures_1.tar.gzorall_structures_2.tar.gz. UpdateARCMOF_STRUCTURES_NAMEin the script if needed. - Element filtering (ARC-MOF): Requires a
formulaorchemical_formulacolumn ingeometric_properties.csv. If the column is absent, all DB7 entries are returned without element filtering. - Post-download: Structures from ARC-MOF DB7 include REPEAT partial charges embedded i