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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ldanalysis-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 9c9c004b7f472c2fd973ab59afd4d09ad0eb7eb2d9b896e3d42c48d04eb85ddb
MD5 86efa03bcbc2405ea642122cc9507e24
BLAKE2b-256 e04d5bbadbaf2de2a036b85e5b8df4d62fed419d2f1302949866493be10020fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldanalysis-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 31.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2102974f336b851ca57b83eb368d346c414b1769bb7c337503073d69a358891c
MD5 09a7707a23b06ce57936e15d3634b047
BLAKE2b-256 078a48afda1ea17d15cbf43f33ab5ee5e6bed893dad924ca70c5d74da4f14e8a

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