Architecture

Architecture

This page presents the system design and structure for the entropic_measurement project.

Overview

• Purpose: Modular library for entropy and information measures on various datasets.

General Diagram (example)

[ User Python Script ]
         |
         v
 [Public API: functions/classes]
         |
   +----------------+
   |     Core       |
   +----------------+
   | Entropy        |
   | Mutual Info    |
   | Etc.           |
   +----------------+
         |
   [Data handling: pandas/numpy]
         |
   [I/O handlers: CSV, JSON, etc.]

Key modules

• core.py: Core functions (e.g., shannon_entropy, mutual_information)
• utils.py: Internal helpers (normalization, binning, error management)
• config.py: Global configuration management (precision, threads, etc.)
• api.py: Stable user-facing interface

Dependencies

• numpy
• scipy
• pandas (optional, for advanced data handling)

Extensibility

• To add new measures: implement a function in core.py and expose it in api.py.
• Configuration through files, environment variables, or runtime parameters.