Skip to content

Latest commit

 

History

History

README.md

LingFrame Tutorials

Progressive tutorials from first analysis to framework extension.


Learning Path

Tutorial Audience Time Description
01: First Analysis Everyone 10 min Analyze your first document
02: Comparative Analysis Researchers 20 min Compare multiple texts
03: Custom Domains Power users 30 min Create specialized analysis profiles
04: Building Modules Developers 45 min Extend the framework

Quick Start

Just want to analyze a document?

./new_venv/bin/python lingframe.py analyze your-document.pdf

Prefer a web interface?

./new_venv/bin/python run_web.py
# Open http://localhost:8501

Sample Corpus

The tutorials use texts from the included corpus:

corpus/
├── classical/
│   ├── odyssey/       Homer's Odyssey (Butler translation)
│   └── aeneid/        Virgil's Aeneid (Dryden translation)
├── medieval/
│   ├── beowulf/       Beowulf (Gummere translation)
│   ├── canterbury-tales/  Chaucer's Canterbury Tales
│   └── inferno/       Dante's Inferno (Longfellow translation)
└── early-modern/
    └── tempest/       Shakespeare's The Tempest

These texts are public domain and span 2,500+ years of literary tradition.


Prerequisites

Before starting, ensure you have:

  1. Python 3.9+ installed
  2. LingFrame dependencies installed:
    pip install -r requirements.txt
    python -m spacy download en_core_web_sm

See the main README for full setup instructions.


Getting Help

  • Documentation: Check docs/ for architecture and theory
  • Issues: Report bugs at the project repository
  • Examples: See projects/ for sample project configurations