academic-primer-framework

Academic Primer Framework

Information

Property	Value
Language	TeX
Stars	0
Forks	0
Watchers	0
Open Issues	0
License	No License
Created	2025-12-30
Last Updated	2026-02-19
Last Push	2026-01-04
Contributors	1
Default Branch	main
Visibility	private

Notebooks

This repository contains 1 notebook(s):

Notebook	Language	Type

| primer_notebook | PYTHON | jupyter |

Reproducibility

No specific reproducibility files found.

Status

Issues: Enabled
Wiki: Enabled
Pages: Enabled

README

Academic Primer Framework

A generic template system for creating academic primers on ANY topic.

Copy templates, replace [PLACEHOLDER] markers with your content, and build.

Documentation

Document	Purpose
ACADEMIC_PRIMER_FRAMEWORK.md	Complete specification (recommended)
USAGE.md	Step-by-step workflow
FRAMEWORK_PROMPT_V3.md	Original prompt specification

Quick Start

# 1. Copy templates
cp paper/main_template.tex paper/main.tex
cp paper/sections_template/*.tex paper/sections/
cp paper/frontmatter_template/*.tex paper/frontmatter/
cp paper/appendices_template/*.tex paper/appendices/

# 2. Replace [PLACEHOLDER] markers in all .tex files

# 3. Create figures from templates
cp -r figures_template/01_line_chart figures/01_my_concept
python figures/01_my_concept/chart.py

# 4. Build and verify
just figures && just build && just qa

Structure

├── figures/                    # Your figures (one chart.py per folder)
│   └── _shared/               # Shared colors.py and styles.py
├── figures_template/          # 7 chart templates
├── paper/
│   ├── main.tex              # Your main document
│   ├── sections/             # 6 sections (01-06)
│   ├── appendices/           # 4 appendices (A-D)
│   ├── frontmatter/          # Abstract, keywords
│   ├── preamble.tex          # LaTeX packages (do not modify)
│   ├── notation.tex          # 100+ math symbols (do not modify)
│   └── references.bib        # Your bibliography
├── scripts/                   # Verification scripts
└── tools/                     # Hallucination prevention

Commands

just figures        # Generate all figures
just build          # Full LaTeX compile (pdflatex + bibtex)
just qa             # Run all verification checks
just clean          # Remove auxiliary files

Key Constraints

Constraint	Requirement
Figures	One chart.py per folder, one chart.pdf per script
Figure size	(10, 6) standard
LaTeX	Zero overflow warnings
Content	All `[PLACEHOLDER]` markers replaced
Integration	Minimum 13 figures referenced

Verification

python tools/run_all_checks.py

Expected output:

  [OK]   Figure Integration   - 13/13 figures
  [OK]   Citation Verification - All entries valid
  [OK]   DOI Resolution       - All DOIs resolve
  [OK]   LaTeX Overflow       - 0 warnings

Requirements

Python 3.8+ (numpy, matplotlib, graphviz)
LaTeX (pdflatex, bibtex)
just (command runner)

License

Private repository - Digital-AI-Finance