archive-nlmnlp
Quick Start
- Command:
archive-nlmnlp [daily|-index] - Local executable:
/home/vimalinx/miniforge3/envs/bio/bin/archive-nlmnlp - Full reference: See references/help.md for complete documentation
When To Use This Tool
- Build a local PubMed concept archive backed by PubTator Central, GeneRIF, and gene metadata files.
- Support offline lookup of chemical, disease, gene, synonym, and GeneRIF-derived postings in EDirect workflows.
- Refresh the archive after upstream concept files change, then rebuild postings in the usual EDirect layout.
- Use this instead of stitching together the PubTator and GeneRIF files manually.
Common Patterns
# 1) Refresh the local NLM NLP extras and archive over HTTPS
export EDIRECT_LOCAL_ARCHIVE=/data/edirect
archive-nlmnlp -https
# 2) Rebuild only the incremental index and invert layers
archive-nlmnlp daily
# 3) Rebuild merged postings for downstream local searching
archive-nlmnlp -index
Recommended Workflow
- Set
EDIRECT_LOCAL_ARCHIVEand confirm the archive root exists and is writable. - Make sure
pm-setup,pm-prepare, and the local Go toolchain are available. - Run
archive-nlmnlporarchive-nlmnlp -httpsto stage the latest PubTator / GeneRIF support files. - Follow with
dailyor-indexas a separate command when you need refreshed postings. - Check the
DWN,IDX,INV,MRG, andPSTtiming blocks to confirm each stage actually ran.
Guardrails
--helpand--versionare not safe inspection switches; they still trigger archive setup and prerequisite checks.- The script depends on
EDIRECT_LOCAL_ARCHIVE,pm-setup,pm-prepare, and a localgocompiler. - Default transport may try the FTP / Aspera path; use
-httpsor-ftpexplicitly if you need predictable transfer behavior. - Cleaning and indexing must be run separately.
- The cleanup aliases remove scratch data, so do not use them casually on a populated archive.