LaTeX manuscript compilation system for scientific documents with MCP server
Project description
SciTeX Writer
A LaTeX compilation system for academic manuscripts with automatic versioning, diff generation, and cross-platform reproducibility.
Part of the fully open-source SciTeX project: https://scitex.ai
Demo
โถ๏ธ Click thumbnail to watch video demo
๐ Full demo (org) | Full demo (pdf) | Manuscript output | Revision output
Quick Start
git clone https://github.com/ywatanabe1989/scitex-writer.git
./scitex-writer/scripts/compile.sh manuscript
Output Structure
./scitex-writer/
โโโ 00_shared/ # Shared resources across all documents
โ โโโ title.tex # Manuscript title
โ โโโ authors.tex # Author names and affiliations
โ โโโ keywords.tex # Keywords for the manuscript
โ โโโ journal_name.tex # Target journal name
โ โโโ bib_files/ # Multiple .bib files (auto-merged and deduplicated)
โ โโโ latex_styles/ # Common LaTeX configurations
โ โโโ templates/ # LaTeX document templates
โ
โโโ 01_manuscript/ # Main manuscript
โ โโโ contents/ # Modular content sections
โ โ โโโ abstract.tex
โ โ โโโ introduction.tex
โ โ โโโ methods.tex
โ โ โโโ results.tex
โ โ โโโ discussion.tex
โ โ โโโ figures/ # Figure captions + media
โ โ โโโ tables/ # Table captions + CSV data
โ โโโ archive/ # Version history (gitignored)
โ โโโ manuscript.tex # Compiled LaTeX
โ โโโ manuscript_diff.tex # Change-tracked version
โ โโโ manuscript.pdf # Output PDF
โ
โโโ 02_supplementary/ # Supplementary materials
โ โโโ contents/ # Supplementary content sections
โ โ โโโ supplementary_methods.tex
โ โ โโโ supplementary_results.tex
โ โ โโโ figures/ # Supplementary figures
โ โ โโโ tables/ # Supplementary tables
โ โโโ archive/ # Version history (gitignored)
โ โโโ supplementary.tex # Compiled LaTeX
โ โโโ supplementary.pdf # Output PDF
โ
โโโ 03_revision/ # Revision response letter
โ โโโ contents/ # Reviewer responses
โ โ โโโ editor/ # E_01_comments.tex, E_01_response.tex
โ โ โโโ reviewer1/ # R1_01_comments.tex, R1_01_response.tex
โ โ โโโ reviewer2/ # R2_01_comments.tex, R2_01_response.tex
โ โโโ archive/ # Version history (gitignored)
โ โโโ revision.tex # Compiled LaTeX
โ โโโ revision.pdf # Output PDF
โ
โโโ config/ # Configuration files
โ โโโ config_manuscript.yaml # Citation style, engine settings
โ
โโโ scripts # Compilation scripts
โโโ containers/ # Container image builds (Apptainer/Singularity)
โโโ installation/ # Environment setup and dependency installation
โโโ maintenance/ # Repository maintenance (usage, update, demos)
โโโ powershell/ # Windows PowerShell scripts
โโโ python/ # Python utilities
โโโ shell/ # Core compilation scripts
Features
Details
| Feature | Description |
|---|---|
| Separated Files | Modular sections (abstract, intro, methods, results, discussion) |
| Built-in Templates | Pre-configured manuscript, supplementary materials, and revision |
| Bibliography | Multi-file with auto-deduplication, 20+ citation styles |
| Assets | Parallel figure/table processing (PNG, PDF, SVG, Mermaid, CSV) |
| Multi-Engine | Auto-selects best engine (Tectonic 1-3s, latexmk 3-6s, 3-pass 12-18s) |
| Cross-Platform | Linux, macOS, WSL2, Docker, Singularity, HPC clusters |
Usage
PDF Compilation
# Basic compilation
./scripts/shell/compile_manuscript.sh # Manuscript
./scripts/shell/compile_supplementary.sh # Supplementary
./scripts/shell/compile_revision.sh # Revision letter
# Performance options
./scripts/shell/compile_manuscript.sh --draft # Fast single-pass
./scripts/shell/compile_manuscript.sh --no-figs # Skip figures
./scripts/shell/compile_manuscript.sh --no-tables # Skip tables
./scripts/shell/compile_manuscript.sh --no-diff # Skip diff generation
# Engine selection
./scripts/shell/compile_manuscript.sh --engine tectonic # Fastest
./scripts/shell/compile_manuscript.sh --engine latexmk # Standard
./scripts/shell/compile_manuscript.sh --engine 3pass # Most compatible
# Development
./scripts/shell/compile_manuscript.sh --watch # Hot-reload on file changes
./scripts/shell/compile_manuscript.sh --clean # Remove cache
Figures
-
Place media files in
01_manuscript/contents/figures/caption_and_media/:01_example_figure.png 01_example_figure.tex # Caption file -
Caption file format (
01_example_figure.tex):%% Figure caption \caption{Your figure caption here. Explain panels (A, B, C) if applicable.} \label{fig:example_figure_01}
-
Supported formats: PNG, JPEG, PDF, SVG, TIFF, Mermaid (.mmd)
-
Figures auto-compile and include in
FINAL.tex
Tables
-
Place CSV + caption in
01_manuscript/contents/tables/caption_and_media/:01_example_table.csv 01_example_table.tex # Caption file -
CSV auto-converts to LaTeX table format
-
Caption file format (
01_example_table.tex):%% Table caption \caption{Your table caption. Define abbreviations used.} \label{tab:example_table_01}
References
Organize references in multiple .bib files - they auto-merge with deduplication:
00_shared/bib_files/
โโโ methods_refs.bib # Method-related references
โโโ field_background.bib # Background literature
โโโ my_papers.bib # Your own publications
Change citation style in config/config_manuscript.yaml:
unsrtnat(numbered, order of citation)plainnat(numbered, alphabetical)apalike(author-year, APA style)IEEEtran(IEEE format)naturemag(Nature style)
Installation
Python Package (MCP Server)
# Install from PyPI
pip install scitex-writer
# Verify installation (CLI or Python module)
scitex-writer --version
python -m scitex_writer version
# Check MCP setup
scitex-writer mcp doctor
python -m scitex_writer mcp doctor
# Start MCP server
scitex-writer mcp start
python -m scitex_writer mcp start
Add to Claude Desktop config (~/.config/Claude/claude_desktop_config.json):
Option 1: CLI command
{
"mcpServers": {
"scitex-writer": {
"command": "scitex-writer",
"args": ["mcp", "start"]
}
}
}
Option 2: Python module
{
"mcpServers": {
"scitex-writer": {
"command": "python",
"args": ["-m", "scitex_writer", "mcp", "start"]
}
}
}
Ubuntu/Debian
sudo apt-get install texlive-latex-extra latexdiff parallel imagemagick ghostscript
macOS
brew install texlive latexdiff parallel imagemagick ghostscript
HPC / Containers
# Module system
module load texlive latexdiff parallel
# Docker
docker run -v $(pwd):/work scitex-writer
# Singularity/Apptainer
singularity run scitex-writer.sif
Documentation
Details
| Guide | Description |
|---|---|
| Installation | Setup for all environments |
| Quick Start | Common workflows |
| Content Creation | Writing manuscripts |
| Bibliography | Reference management |
| Architecture | Technical details |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file scitex_writer-0.1.2.tar.gz.
File metadata
- Download URL: scitex_writer-0.1.2.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.0rc1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7f233e8992bbb5fafca8505f8cdc71b50323f3b1f30dfe77d1b70cc2e776635
|
|
| MD5 |
f867510df7cf3554b156328ebb14102c
|
|
| BLAKE2b-256 |
bec5c02ac892c2053342910500794be27c6374d5a8a55e09590f607c2fafeb6b
|
File details
Details for the file scitex_writer-0.1.2-py3-none-any.whl.
File metadata
- Download URL: scitex_writer-0.1.2-py3-none-any.whl
- Upload date:
- Size: 28.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.0rc1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a15fedec379975bc9448f2057e46ad42c2a4a23aa12baff26f85f6b05c0737c
|
|
| MD5 |
62cadfcdfd8155e448b30e97170efb1d
|
|
| BLAKE2b-256 |
8af087b9452d8265f2d98d7ceca14fc85c08e3e35de0215c82775fccf242b3b2
|