Setup Overview


Supported Systems

prismAId is accessible across multiple platforms, offering flexibility based on user preference and system requirements:

  1. Binaries: Standalone executables for Windows, macOS, and Linux, requiring no coding skills.

  2. Go Package: Full functionality for Go-based projects.

  3. Python Package on PyPI: For integration in Python scripts and Jupyter notebooks.

  4. R Package on R-universe: Compatible with R and RStudio environments.

  5. Julia Package from the Julia official package registry: For integration in Julia workflows and Jupyter notebooks.

Toolkit Overview

prismAId offers several specialized tools to support systematic reviews:

  1. Screening Tool: Filter manuscripts to identify items for exclusion
    • Remove duplicates using exact or fuzzy matching
    • Filter by language detection
    • Classify and filter by article type (research, review, editorial, etc.)
  2. Review Tool: Process systematic literature reviews based on TOML configurations
    • Configure review criteria, AI model settings, and output formats
    • Extract structured information from scientific papers
    • Generate comprehensive review summaries
  3. Download Tool: Acquire papers for your review
    • Download PDFs directly from Zotero collections
    • Download files from URL lists
  4. Convert Tool: Transform documents into analyzable text
    • Convert PDFs, DOCX, and HTML files to plain text
    • Prepare documents for AI processing

Workflow Overview

  1. AI Model Provider Account and API Key:
    • Register for an account with OpenAI, GoogleAI, Cohere, or Anthropic and obtain an API key.
    • Generate an API key from the provider’s dashboard.
  2. Install prismAId:
    • Follow the installation instructions below based on your preferred system.
  3. Prepare Papers for Review:
    • Download papers using the Download tool
    • Convert papers to text format using the Convert tool
  4. Define and Run the Review Project:
    • Set up a configuration file (.toml) for your review project
    • Use the Review tool to process your papers and extract information