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.1.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.1-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ldanalysis-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2a702de2a07274738c3a34300ee6976803d3322a39a5ed553331ecc5569d431b
MD5 5a49046cd4584bf3f54b227a7f79172a
BLAKE2b-256 349c3262bffe0f7ae856d8b0e408b3b603ca301c2b21eb7271809c6a861b2e23

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldanalysis-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 30.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0ff9b9e7844915828a7c04057a1419ac2e6d1a04cbf941db70351ae323961f0
MD5 16ee419edc54d7a19cf6a770adb8f39e
BLAKE2b-256 abe4cb87f23d8b1ff8386fb806da27dca1c341b8a1ffe888deeebd82d96a766a

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