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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ldanalysis-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 d8575ee2f0722f63f847b5ffcf567e9828df9632a897541d3fa51665ecded030
MD5 cec996df5793e32120fc38a53d93395d
BLAKE2b-256 22405dd47cf4fe11f0877292bfd295cd892c7af3ecbc025f78e5f6b8091b047c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldanalysis-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7af2e012919b1a117f9f3a0a84bc6b4f18d7660f5eb83afefc862604dcaf4faf
MD5 eed563ffbebadfcc017d8644952eb595
BLAKE2b-256 71e9943e0590dc97364842ee41df35cab2166981d6a3d912a5bd23d5c03246d6

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