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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ldanalysis-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 4048d398f9e2ffe71d152e48fe9fe32da54edcab894de77b09b2903668105152
MD5 dc264899d89c62e50ca96a3d8a3d3966
BLAKE2b-256 7500c15f35ff4a08c2d5afe55a75683d4190a95818806a541b9e503bdaf63253

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldanalysis-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b23b0146253a5f8392ef8e6b10ed67df47d21f355a943dc7b30867fe88c1d83d
MD5 3b456b62aaf59e3f2efbf919c0b74328
BLAKE2b-256 955abc328ef2bbb27db51225387ffa7d2b602955228932c227a432209d4c5dac

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