Documentation

Getting started

Set up the runtime, configure a model, and create your first paper workspace.

Requirements

Linux with Python 3.11 or newer.
Docker Engine and Docker Compose.
Poppler utilities, including pdffonts.
At least one available model API key.
An optional NVIDIA GPU to speed up PDF parsing.

Installation

git clone <repository-url>
cd CCIIP_Scope
./install.sh

The installer checks dependencies one by one. Before making changes to the host system, it explains the operation and asks for confirmation.

Start the application

./start.sh

The web interface is available at http://127.0.0.1:8010 by default.

Use the setup scripts.install.sh installs dependencies, creates the virtual environment, and prepares tools such as SearXNG and MinerU. For later runs, start the project directly with start.sh.

LAN access

By default, the installer configures an Nginx reverse proxy so other devices on the same local network can reach CScope. After start.sh starts, the terminal lists the available LAN access addresses.

The default policy allows localhost, common private-network ranges, and Tailscale addresses. Use --allow-cidr to add a network, combine it with --replace-default-cidrs to allow only specified ranges, or use --skip-nginx when LAN access is not needed.

Configure a model

If the installer did not create .env, create it from the example file:

cp .env.example .env

Add the name, base URL, and API key for MiniMax or another compatible model to .env. Model APIs can also be configured from the web interface.

Create the first project

Open the web interface and upload a PDF or LaTeX ZIP.
Select the conference you plan to submit to. For a LaTeX archive, also select the main .tex file.
Create the project and save the generated ppr_... token for future access.
Open the workspace and wait for processing to finish.

The token is the access credential for that project. It cannot be recovered from the public interface if it is lost.

Stop the application

Press Ctrl+C in the terminal running start.sh to stop CScope and its Docker services.