Documentation

Getting started

Install the runtime, configure one model, and create a private paper workspace.

Requirements

Linux or WSL2 with Python 3.11 or newer.
Docker Engine and Docker Compose.
Poppler utilities, including pdffonts.
At least one supported model API credential.
Optional NVIDIA GPU for faster on-demand MinerU parsing.
Optional TeX distribution when local compilation is enabled.

Install and run are separate.install.sh prepares host packages, the virtual environment, SearXNG, and the MinerU image. start.sh only starts an already prepared installation.

Installation

git clone https://github.com/Sata-moto/CCIIP_Scope.git
cd CCIIP_Scope
./install.sh

The guided installer reports each prerequisite and asks before host-level changes. It respects the Docker registry configuration already present on the machine.

Start the application

./start.sh

The default application address is http://127.0.0.1:8010. SearXNG starts with CciipScope. MinerU starts only while a PDF is being parsed and is stopped immediately afterward.

Configure a model

Copy the example environment file if the installer did not create one, then add a credential:

cp .env.example .env
MINIMAX_API_KEY=your_key_here

Additional models can be registered from a completed workspace or directly in .env using the CCIIPSCOPE_MODEL_<NAME>_* variables described in the configuration reference.

Create the first project

Open the submission page.
Select a PDF or LaTeX ZIP archive.
For a LaTeX archive, explicitly select the main .tex file.
Select the target conference.
Create the project and store the generated ppr_... access token.
Open the workspace and follow the analysis progress.

The token is the only credential for that workspace and is shown in full only once.

Expected stages

Parsing paper
Building research landscape
Checking mechanical compliance
Analyzing methodology
Checking macro logic and consistency
Deliberating the full review
Analyzing manuscript sections
Building the revision checklist

Stop the application

Press Ctrl+C in the launcher terminal. The launcher closes the supporting services it started. Projects remain available until they are deleted manually or reach the configured retention limit.