Skip to main content

Linked Document Analysis - A provenance-driven project management system

Project description

Linked Document Analysis (LDA)

A project management and provenance system where every analytical process, input, and output is mapped directly to a section of the working document (e.g., manuscript, protocol, regulatory report).

Each analysis folder, manifest, and result is named and organized to mirror the document outline, creating a one-to-one link between text, code, data, and results.

This architecture ensures that every figure, table, or claim in the document is transparently and immutably traceable back to its generating code and data—enabling instant audit, replication, and regulatory review.

Installation

Requires Python 3.10 or later with the Rich library for enhanced terminal output.

pip install rich

Usage

Create a new LDA project scaffold:

python lda_scaffold.py

The scaffold will:

  1. Create section folders matching your document structure
  2. Generate file manifests for inputs and outputs
  3. Set up provenance tracking with unique IDs
  4. Initialize logging and documentation

Project Structure

Each LDA project contains:

  • Section folders: One-to-one mapping with document sections
  • File manifests: Explicit lists of expected inputs and outputs
  • Provenance tracking: Hashes, timestamps, and analyst attribution
  • Audit logs: Complete history of all changes

Documentation

See CLAUDE.md for detailed architecture and usage instructions.

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ldanalysis-0.1.2.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ldanalysis-0.1.2-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file ldanalysis-0.1.2.tar.gz.

File metadata

  • Download URL: ldanalysis-0.1.2.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for ldanalysis-0.1.2.tar.gz
Algorithm Hash digest
SHA256 85ff98c0da74ea79a962912b4be30be1bdc0e475074f586976a410b3399f856d
MD5 b2e041a4d78f436a6bc1674980b9f96c
BLAKE2b-256 e64c5f40f91a36caa45dfcbbb3dd64a728eb038bbdee76bc00714a9681ebbd11

See more details on using hashes here.

File details

Details for the file ldanalysis-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ldanalysis-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for ldanalysis-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a036ca49fef827d8826e476dc44e62f7cfdc735c0289da4fef130d18b26cd9be
MD5 d482c2af420a78249ec9179f11d8bd2d
BLAKE2b-256 6eed494f7794250a55d6c7bb04307ec150264c9cd27722bdbd98d38e735c9a38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page