Design#
Core idea#
litmap is built around one central distinction:
analysis space determines cluster membership
display space determines how the result is shown on a map
That rule keeps a visually pleasing map from silently redefining the underlying cluster structure.
Architectural layers#
sourcesingest external records from PubMed, OpenAlex, Semantic Scholar, or local filescorpusnormalize metadata, build embedding input text, and deduplicate recordsembedgenerate literature embeddingsanalyzenormalize, reduce, cluster, and summarizevisualizeexport interactive maps and shareable figuresstoragedefine the artifact contract for runspipelineorchestrate the stages
Run naming#
Run directories should use human-readable names such as:
immunotherapy-landscapeglioma-methods-scansingle-cell-review
Timestamps should not be part of the primary run name.
Why the docs are case-study oriented#
A package like litmap is easier to trust when the documentation shows the shapes of real outputs. That is why the tutorials are written around result artifacts rather than only around setup commands.