Skip to content

Installation

Requirements

Dependency Version Purpose
Python >= 3.10 CLI and package management
Node.js >= 18 UI server runtime

Install from PyPI

pip install researchpad

Verify the installation:

researchpad version

Install from Source

Clone the repository and install in development mode:

git clone https://github.com/researchpad/researchpad.git
cd researchpad
pip install -e ".[dev,docs]"

Then build the frontend and server bundles:

make build

Node.js is required at runtime

ResearchPad's UI server runs on Node.js. The researchpad runserver command will check for a node binary on your PATH and exit with a helpful error if it is missing.

Upgrading

pip install --upgrade researchpad

Next Steps

Once installed, head to the Quick Start guide to initialize your first project.