Skip to main content

scitrail

scitrail builds an easy-to-read markdown report of the top voices in a field, including ORCID identifiers and a concise state-of-the-art executive summary.

The workflow is:

  1. Read a YAML config (institution, optional department/departments, topic/topics, and simple knobs).
  2. Resolve the institution in OpenAlex (with ROR when available).
  3. Scan topic-relevant literature in that institution.
  4. Rank the top voices (configurable count).
  5. Summarize each voice and produce an executive summary.
  6. Render a markdown report.

Install

uv sync

Optional local model support (for local LLM summarization with instructor):

uv sync --extra local-llm

Example config

institution: CU Anschutz
departments:
  - Department of Biomedical Informatics
topics:
  - Quantum
  - Artificial intelligence
max_people: 5
works_per_person: 8
lookback_years: 5
openalex_email: you@example.org
# openalex_api_key: <optional>
llm:
  enabled: false

CLI

Generate a markdown report file:

uv run scitrail generate --config examples/cu_quantum.yaml --output report.md

Preview markdown in terminal:

uv run scitrail preview --config examples/cu_quantum.yaml

Compare department-scoped vs all-departments runs:

uv run scitrail generate --config examples/cu_topics_dbmi.yaml --output examples/cu_topics_dbmi_report.md
uv run scitrail generate --config examples/cu_topics_all_departments.yaml --output examples/cu_topics_all_departments_report.md

Run the built-in example end-to-end and write examples/cu_quantum_report.md:

uv run scitrail example

Execute the docs notebook version (renders rich markdown output in the notebook):

uv run --group docs --group notebooks poe docs-notebook-cu-quantum

Notes

  • OpenAlex API keys are recommended for non-trivial usage.
  • If local LLM dependencies are unavailable, scitrail automatically falls back to deterministic summaries so reports still complete.

Metadata

Release files for scitrail 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scitrail 0.0.1
File Size Uploaded
scitrail-0.0.1.tar.gz 183.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scitrail 0.0.1
File Interpreter ABI Platform
scitrail-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 201.3 kB

Release files / scitrail-0.0.1.tar.gz

Download URL scitrail-0.0.1.tar.gz
Size 183.1 kB
Tags Source
SHA-256 checksum
How to use checksums
58ed4343f8d6e9935e5e1f69ac243ba38bbb08bc1e50ec7ab737e41c7652d6f5
BLAKE2b-256 checksum
How to use checksums
6b25d844af45ec32aa19b44867eeeebb5234eb299f38e46556b017f702d7ff15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 20, 2026.

Transparency log

Release files / scitrail-0.0.1-py3-none-any.whl

Download URL scitrail-0.0.1-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b5c01dc416614e1b77c2693417a7d95ebd15186a5efe451f28fbfdd616b5af1
BLAKE2b-256 checksum
How to use checksums
2e7237338d55f787fb9a51997a1af3b6eb8c0527aeb8127a9cf81ec7ddaa0a0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 20, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page